LLVM 24.0.0git
VPlanTransforms.cpp
Go to the documentation of this file.
1//===-- VPlanTransforms.cpp - Utility VPlan to VPlan transforms -----------===//
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 file implements a set of utility VPlan to VPlan transformations.
11///
12//===----------------------------------------------------------------------===//
13
14#include "VPlanTransforms.h"
15#include "VPRecipeBuilder.h"
16#include "VPlan.h"
17#include "VPlanAnalysis.h"
18#include "VPlanCFG.h"
19#include "VPlanDominatorTree.h"
20#include "VPlanHelpers.h"
21#include "VPlanPatternMatch.h"
22#include "VPlanUtils.h"
23#include "llvm/ADT/APInt.h"
25#include "llvm/ADT/STLExtras.h"
26#include "llvm/ADT/SetVector.h"
28#include "llvm/ADT/TypeSwitch.h"
30#include "llvm/Analysis/Loads.h"
36#include "llvm/IR/Intrinsics.h"
37#include "llvm/IR/Metadata.h"
41
42using namespace llvm;
43using namespace VPlanPatternMatch;
44using namespace SCEVPatternMatch;
45
46/// If the pointer operand \p Addr of a memory access is an affine AddRec
47/// w.r.t. \p L with a constant stride, return the stride in units of
48/// \p AccessTy. Otherwise return std::nullopt.
49static std::optional<int64_t> getConstantStride(VPValue *Addr, Type *AccessTy,
51 const Loop *L) {
52 assert(!hasIrregularType(AccessTy, L->getHeader()->getDataLayout()) &&
53 "should not try to widen irregular types");
54 const SCEV *AddrSCEV = vputils::getSCEVExprForVPValue(Addr, PSE, L);
55 auto *AddRec = dyn_cast<SCEVAddRecExpr>(AddrSCEV);
56 if (!AddRec)
57 return {};
58
59 return getStrideFromAddRec(AddRec, L, AccessTy, /*Ptr=*/nullptr, PSE);
60}
61
64 Loop *OuterLoop) {
65
66 // Returns true if the access of \p AccessTy at \p Addr can be widened to a
67 // consecutive vector access.
68 auto IsConsecutiveAccess = [&](VPValue *Addr, Type *AccessTy) {
69 return !hasIrregularType(AccessTy, Plan.getDataLayout()) &&
70 getConstantStride(Addr, AccessTy, PSE, OuterLoop) == 1;
71 };
72
74 Plan.getVectorLoopRegion());
76 // Skip blocks outside region
77 if (!VPBB->getParent())
78 break;
79 VPRecipeBase *Term = VPBB->getTerminator();
80 auto EndIter = Term ? Term->getIterator() : VPBB->end();
81 // Introduce each ingredient into VPlan.
82 for (VPRecipeBase &Ingredient :
83 make_early_inc_range(make_range(VPBB->begin(), EndIter))) {
84
85 VPValue *VPV = Ingredient.getVPSingleValue();
86 if (!VPV->getUnderlyingValue())
87 continue;
88
90
91 // Atomic accesses and fences have ordering/atomicity semantics that
92 // cannot be preserved by lane-wise widening.
94 return false;
95
96 VPRecipeBase *NewRecipe = nullptr;
97 if (auto *PhiR = dyn_cast<VPPhi>(&Ingredient)) {
98 auto *Phi = cast<PHINode>(PhiR->getUnderlyingValue());
99 NewRecipe = new VPWidenPHIRecipe(PhiR->operands(), PhiR->getDebugLoc(),
100 Phi->getName());
101 } else if (auto *VPI = dyn_cast<VPInstruction>(&Ingredient)) {
102 assert(!isa<PHINode>(Inst) && "phis should be handled above");
103 // Create VPWidenMemoryRecipe for loads and stores.
104 if (LoadInst *Load = dyn_cast<LoadInst>(Inst)) {
105 bool IsConsecutive =
106 IsConsecutiveAccess(VPI->getOperand(0), VPI->getScalarType());
107 NewRecipe = new VPWidenLoadRecipe(*Load, Ingredient.getOperand(0),
108 nullptr /*Mask*/, IsConsecutive,
109 *VPI, Ingredient.getDebugLoc());
110 } else if (StoreInst *Store = dyn_cast<StoreInst>(Inst)) {
111 bool IsConsecutive = IsConsecutiveAccess(
112 VPI->getOperand(1), VPI->getOperand(0)->getScalarType());
113 NewRecipe = new VPWidenStoreRecipe(
114 *Store, Ingredient.getOperand(1), Ingredient.getOperand(0),
115 nullptr /*Mask*/, IsConsecutive, *VPI, Ingredient.getDebugLoc());
117 NewRecipe = new VPWidenGEPRecipe(GEP->getSourceElementType(),
118 Ingredient.operands(), *VPI,
119 Ingredient.getDebugLoc(), GEP);
120 } else if (CallInst *CI = dyn_cast<CallInst>(Inst)) {
121 Intrinsic::ID VectorID = getVectorIntrinsicIDForCall(CI, &TLI);
122 if (VectorID == Intrinsic::not_intrinsic)
123 return false;
124
125 // The noalias.scope.decl intrinsic declares a noalias scope that
126 // is valid for a single iteration. Emitting it as a single-scalar
127 // replicate would incorrectly extend the scope across multiple
128 // original iterations packed into one vector iteration.
129 // FIXME: If we want to vectorize this loop, then we have to drop
130 // all the associated !alias.scope and !noalias.
131 if (VectorID == Intrinsic::experimental_noalias_scope_decl)
132 return false;
133
134 // These intrinsics are recognized by getVectorIntrinsicIDForCall
135 // but are not widenable. Emit them as replicate instead of widening.
136 if (VectorID == Intrinsic::assume ||
137 VectorID == Intrinsic::lifetime_end ||
138 VectorID == Intrinsic::lifetime_start ||
139 VectorID == Intrinsic::sideeffect ||
140 VectorID == Intrinsic::pseudoprobe) {
141 // If the operand of llvm.assume holds before vectorization, it will
142 // also hold per lane.
143 // llvm.pseudoprobe requires to be duplicated per lane for accurate
144 // sample count.
145 const bool IsSingleScalar = VectorID != Intrinsic::assume &&
146 VectorID != Intrinsic::pseudoprobe;
147 NewRecipe = new VPReplicateRecipe(CI, Ingredient.operands(),
148 /*IsSingleScalar=*/IsSingleScalar,
149 /*Mask=*/nullptr, *VPI, *VPI,
150 Ingredient.getDebugLoc());
151 } else {
152 NewRecipe = new VPWidenIntrinsicRecipe(
153 *CI, VectorID, drop_end(Ingredient.operands()), CI->getType(),
154 VPIRFlags(*CI), *VPI, CI->getDebugLoc());
155 }
156 } else if (auto *CI = dyn_cast<CastInst>(Inst)) {
157 NewRecipe = new VPWidenCastRecipe(
158 CI->getOpcode(), Ingredient.getOperand(0), CI->getType(), CI,
159 VPIRFlags(*CI), VPIRMetadata(*CI));
160 } else {
161 NewRecipe = new VPWidenRecipe(*Inst, Ingredient.operands(), *VPI,
162 *VPI, Ingredient.getDebugLoc());
163 }
164 } else {
166 "inductions must be created earlier");
167 continue;
168 }
169
170 NewRecipe->insertBefore(&Ingredient);
171 if (NewRecipe->getNumDefinedValues() == 1)
172 VPV->replaceAllUsesWith(NewRecipe->getVPSingleValue());
173 else
174 assert(NewRecipe->getNumDefinedValues() == 0 &&
175 "Only recpies with zero or one defined values expected");
176 Ingredient.eraseFromParent();
177 }
178 }
179 return true;
180}
181
182/// Helper for extra no-alias checks via known-safe recipe and SCEV.
185 VPReplicateRecipe &GroupLeader;
186 PredicatedScalarEvolution *PSE = nullptr;
187 const Loop *L = nullptr;
188
189 // Return true if \p A and \p B are known to not alias for all VFs in the
190 // plan, checked via the distance between the accesses
191 bool isNoAliasViaDistance(VPReplicateRecipe *A, VPReplicateRecipe *B) const {
192 if (A->getOpcode() != Instruction::Store ||
193 B->getOpcode() != Instruction::Store)
194 return false;
195
196 if (!PSE || !L)
197 return A == B;
198
199 VPValue *AddrA = A->getOperand(1);
200 const SCEV *SCEVA = vputils::getSCEVExprForVPValue(AddrA, *PSE, L);
201 VPValue *AddrB = B->getOperand(1);
202 const SCEV *SCEVB = vputils::getSCEVExprForVPValue(AddrB, *PSE, L);
204 return false;
205
206 const APInt *Distance;
207 ScalarEvolution &SE = *PSE->getSE();
208 if (!match(SE.getMinusSCEV(SCEVA, SCEVB), m_scev_APInt(Distance)))
209 return false;
210
211 const DataLayout &DL = SE.getDataLayout();
212 Type *TyA = A->getOperand(0)->getScalarType();
213 uint64_t SizeA = DL.getTypeStoreSize(TyA);
214 Type *TyB = B->getOperand(0)->getScalarType();
215 uint64_t SizeB = DL.getTypeStoreSize(TyB);
216
217 // Use the maximum store size to ensure no overlap from either direction.
218 // Currently only handles fixed sizes, as it is only used for
219 // replicating VPReplicateRecipes.
220 uint64_t MaxStoreSize = std::max(SizeA, SizeB);
221
222 auto VFs = B->getParent()->getPlan()->vectorFactors();
224 if (MaxVF.isScalable())
225 return false;
226 return Distance->abs().uge(
227 MaxVF.multiplyCoefficientBy(MaxStoreSize).getFixedValue());
228 }
229
230public:
233 const Loop &L)
234 : ExcludeRecipes(ExcludeRecipes.begin(), ExcludeRecipes.end()),
235 GroupLeader(GroupLeader), PSE(&PSE), L(&L) {}
236
237 SinkStoreInfo(VPReplicateRecipe &GroupLeader) : GroupLeader(GroupLeader) {}
238
239 /// Return true if \p R should be skipped during alias checking, either
240 /// because it's in the exclude set or because no-alias can be proven via
241 /// SCEV.
242 bool shouldSkip(VPRecipeBase &R) const {
244 return ExcludeRecipes.contains(Store) ||
245 (Store && isNoAliasViaDistance(Store, &GroupLeader));
246 }
247};
248
249/// Check if a memory operation doesn't alias with memory operations using
250/// scoped noalias metadata, in blocks in the single-successor chain between \p
251/// FirstBB and \p LastBB. If \p SinkInfo is std::nullopt, only recipes that may
252/// write to memory are checked (for load hoisting). Otherwise recipes that both
253/// read and write memory are checked, and SCEV is used to prove no-alias
254/// between the group leader and other replicate recipes (for store sinking).
255static bool
257 VPBasicBlock *FirstBB, VPBasicBlock *LastBB,
258 std::optional<SinkStoreInfo> SinkInfo = {}) {
259 bool CheckReads = SinkInfo.has_value();
260 for (VPBasicBlock *VPBB :
262 for (VPRecipeBase &R : *VPBB) {
263 if (SinkInfo && SinkInfo->shouldSkip(R))
264 continue;
265
266 // Skip recipes that don't need checking.
267 if (!R.mayWriteToMemory() && !(CheckReads && R.mayReadFromMemory()))
268 continue;
269
271 if (!Loc)
272 // Conservatively assume aliasing for memory operations without
273 // location.
274 return false;
275
277 return false;
278 }
279 }
280 return true;
281}
282
283/// Get the value type of the replicate load or store. \p IsLoad indicates
284/// whether it is a load.
286 return (IsLoad ? R : R->getOperand(0))->getScalarType();
287}
288
289/// Collect either replicated Loads or Stores grouped by their address SCEV and
290/// their load-store type, in a deep-traversal of the vector loop region in \p
291/// Plan.
292template <unsigned Opcode>
295 VPlan &Plan, PredicatedScalarEvolution &PSE, const Loop *L,
296 function_ref<bool(VPReplicateRecipe *)> FilterFn) {
297 static_assert(Opcode == Instruction::Load || Opcode == Instruction::Store,
298 "Only Load and Store opcodes supported");
299 constexpr bool IsLoad = (Opcode == Instruction::Load);
302 RecipesByAddressAndType;
305 for (VPRecipeBase &R : *VPBB) {
306 auto *RepR = dyn_cast<VPReplicateRecipe>(&R);
307 if (!RepR || RepR->getOpcode() != Opcode || !FilterFn(RepR))
308 continue;
309
310 // For loads, operand 0 is address; for stores, operand 1 is address.
311 VPValue *Addr = RepR->getOperand(IsLoad ? 0 : 1);
312 const Type *LoadStoreTy = getLoadStoreValueType(RepR, IsLoad);
313 const SCEV *AddrSCEV = vputils::getSCEVExprForVPValue(Addr, PSE, L);
314 if (!isa<SCEVCouldNotCompute>(AddrSCEV))
315 RecipesByAddressAndType[{AddrSCEV, LoadStoreTy}].push_back(RepR);
316 }
317 }
318 auto Groups = to_vector(RecipesByAddressAndType.values());
319 VPDominatorTree VPDT(Plan);
320 for (auto &Group : Groups) {
321 // Sort mem ops by dominance order, with earliest (most dominating) first.
323 return VPDT.properlyDominates(A, B);
324 });
325 }
326 return Groups;
327}
328
329static bool sinkScalarOperands(VPlan &Plan) {
330 auto Iter = vp_depth_first_deep(Plan.getEntry());
331 bool ScalarVFOnly = Plan.hasScalarVFOnly();
332 bool Changed = false;
333
335 auto InsertIfValidSinkCandidate = [ScalarVFOnly, &WorkList](
336 VPBasicBlock *SinkTo, VPValue *Op) {
337 auto *Candidate = dyn_cast<VPSingleDefRecipe>(Op);
339 VPInstruction>(Candidate))
340 return;
341
342 if (Candidate->getParent() == SinkTo ||
343 all_of(Candidate->operands(),
344 [](VPValue *Op) { return Op->isDefinedOutsideLoopRegions(); }) ||
345 vputils::cannotHoistOrSinkRecipe(*Candidate, /*Sinking=*/true))
346 return;
347
348 if (!ScalarVFOnly && !vputils::doesGeneratePerAllLanes(Candidate))
349 return;
350
351 // Only single-scalar VPInstructions can be sunk.
352 if (auto *VPI = dyn_cast<VPInstruction>(Candidate))
353 if (!vputils::isSingleScalar(VPI))
354 return;
355
356 WorkList.insert({SinkTo, Candidate});
357 };
358
359 // First, collect the operands of all recipes in replicate blocks as seeds for
360 // sinking.
362 VPBasicBlock *EntryVPBB = VPR->getEntryBasicBlock();
363 if (!VPR->isReplicator() || EntryVPBB->getSuccessors().size() != 2)
364 continue;
365 VPBasicBlock *VPBB = cast<VPBasicBlock>(EntryVPBB->getSuccessors().front());
366 if (VPBB->getSingleSuccessor() != VPR->getExitingBasicBlock())
367 continue;
368 for (auto &Recipe : *VPBB)
369 for (VPValue *Op : Recipe.operands())
370 InsertIfValidSinkCandidate(VPBB, Op);
371 }
372
373 // Try to sink each replicate or scalar IV steps recipe in the worklist.
374 for (unsigned I = 0; I != WorkList.size(); ++I) {
375 VPBasicBlock *SinkTo;
376 VPSingleDefRecipe *SinkCandidate;
377 std::tie(SinkTo, SinkCandidate) = WorkList[I];
378
379 // All recipe users of SinkCandidate must be in the same block SinkTo or all
380 // users outside of SinkTo must only use the first lane of SinkCandidate. In
381 // the latter case, we need to duplicate SinkCandidate.
382 auto UsersOutsideSinkTo =
383 make_filter_range(SinkCandidate->users(), [SinkTo](VPUser *U) {
384 return cast<VPRecipeBase>(U)->getParent() != SinkTo;
385 });
386 if (any_of(UsersOutsideSinkTo, [SinkCandidate](VPUser *U) {
387 return !U->usesFirstLaneOnly(SinkCandidate);
388 }))
389 continue;
390 bool NeedsDuplicating = !UsersOutsideSinkTo.empty();
391
392 if (NeedsDuplicating) {
393 if (ScalarVFOnly)
394 continue;
395 VPSingleDefRecipe *Clone;
396 if (auto *SinkCandidateRepR =
397 dyn_cast<VPReplicateRecipe>(SinkCandidate)) {
398 // TODO: Handle converting to uniform recipes as separate transform,
399 // then cloning should be sufficient here.
401 SinkCandidateRepR->getOpcode(), SinkCandidate->operands(),
402 /*Mask=*/nullptr, *SinkCandidateRepR, *SinkCandidateRepR,
403 SinkCandidate->getDebugLoc(), SinkCandidate->getUnderlyingInstr());
404 // TODO: add ".cloned" suffix to name of Clone's VPValue.
405 } else {
406 Clone = SinkCandidate->clone();
407 }
408
409 Clone->insertBefore(SinkCandidate);
410 SinkCandidate->replaceUsesWithIf(Clone, [SinkTo](VPUser &U, unsigned) {
411 return cast<VPRecipeBase>(&U)->getParent() != SinkTo;
412 });
413 }
414 SinkCandidate->moveBefore(*SinkTo, SinkTo->getFirstNonPhi());
415 for (VPValue *Op : SinkCandidate->operands())
416 InsertIfValidSinkCandidate(SinkTo, Op);
417 Changed = true;
418 }
419 return Changed;
420}
421
422/// If \p R is a triangle region, return the 'then' block of the triangle.
424 auto *EntryBB = cast<VPBasicBlock>(R->getEntry());
425 if (EntryBB->getNumSuccessors() != 2)
426 return nullptr;
427
428 auto *Succ0 = dyn_cast<VPBasicBlock>(EntryBB->getSuccessors()[0]);
429 auto *Succ1 = dyn_cast<VPBasicBlock>(EntryBB->getSuccessors()[1]);
430 if (!Succ0 || !Succ1)
431 return nullptr;
432
433 if (Succ0->getNumSuccessors() + Succ1->getNumSuccessors() != 1)
434 return nullptr;
435 if (Succ0->getSingleSuccessor() == Succ1)
436 return Succ0;
437 if (Succ1->getSingleSuccessor() == Succ0)
438 return Succ1;
439 return nullptr;
440}
441
442// Merge replicate regions in their successor region, if a replicate region
443// is connected to a successor replicate region with the same predicate by a
444// single, empty VPBasicBlock.
446 SmallPtrSet<VPRegionBlock *, 4> TransformedRegions;
447
448 // Collect replicate regions followed by an empty block, followed by another
449 // replicate region with matching masks to process front. This is to avoid
450 // iterator invalidation issues while merging regions.
453 vp_depth_first_deep(Plan.getEntry()))) {
454 if (!Region1->isReplicator())
455 continue;
456 auto *MiddleBasicBlock =
457 dyn_cast_or_null<VPBasicBlock>(Region1->getSingleSuccessor());
458 if (!MiddleBasicBlock || !MiddleBasicBlock->empty())
459 continue;
460
461 auto *Region2 =
462 dyn_cast_or_null<VPRegionBlock>(MiddleBasicBlock->getSingleSuccessor());
463 if (!Region2 || !Region2->isReplicator())
464 continue;
465
466 VPValue *Mask1 = Region1->getEntryBranchOnMask()->getOperand(0);
467 VPValue *Mask2 = Region2->getEntryBranchOnMask()->getOperand(0);
468 if (!Mask1 || Mask1 != Mask2)
469 continue;
470
471 assert(Mask1 && Mask2 && "both region must have conditions");
472 WorkList.push_back(Region1);
473 }
474
475 // Move recipes from Region1 to its successor region, if both are triangles.
476 for (VPRegionBlock *Region1 : WorkList) {
477 if (TransformedRegions.contains(Region1))
478 continue;
479 auto *MiddleBasicBlock = cast<VPBasicBlock>(Region1->getSingleSuccessor());
480 auto *Region2 = cast<VPRegionBlock>(MiddleBasicBlock->getSingleSuccessor());
481
482 VPBasicBlock *Then1 = getPredicatedThenBlock(Region1);
483 VPBasicBlock *Then2 = getPredicatedThenBlock(Region2);
484 if (!Then1 || !Then2)
485 continue;
486
487 // Note: No fusion-preventing memory dependencies are expected in either
488 // region. Such dependencies should be rejected during earlier dependence
489 // checks, which guarantee accesses can be re-ordered for vectorization.
490 //
491 // Move recipes to the successor region.
492 for (VPRecipeBase &ToMove : make_early_inc_range(reverse(*Then1)))
493 ToMove.moveBefore(*Then2, Then2->getFirstNonPhi());
494
495 auto *Merge1 = cast<VPBasicBlock>(Then1->getSingleSuccessor());
496 auto *Merge2 = cast<VPBasicBlock>(Then2->getSingleSuccessor());
497
498 // Move VPPredInstPHIRecipes from the merge block to the successor region's
499 // merge block. Update all users inside the successor region to use the
500 // original values.
501 for (VPRecipeBase &Phi1ToMove : make_early_inc_range(reverse(*Merge1))) {
502 VPValue *PredInst1 =
503 cast<VPPredInstPHIRecipe>(&Phi1ToMove)->getOperand(0);
504 VPValue *Phi1ToMoveV = Phi1ToMove.getVPSingleValue();
505 Phi1ToMoveV->replaceUsesWithIf(PredInst1, [Then2](VPUser &U, unsigned) {
506 return cast<VPRecipeBase>(&U)->getParent() == Then2;
507 });
508
509 // Remove phi recipes that are unused after merging the regions.
510 if (Phi1ToMove.getVPSingleValue()->user_empty()) {
511 Phi1ToMove.eraseFromParent();
512 continue;
513 }
514 Phi1ToMove.moveBefore(*Merge2, Merge2->begin());
515 }
516
517 // Remove the dead recipes in Region1's entry block.
518 for (VPRecipeBase &R :
519 make_early_inc_range(reverse(*Region1->getEntryBasicBlock())))
520 R.eraseFromParent();
521
522 // Finally, remove the first region.
523 for (VPBlockBase *Pred : make_early_inc_range(Region1->getPredecessors())) {
524 VPBlockUtils::disconnectBlocks(Pred, Region1);
525 VPBlockUtils::connectBlocks(Pred, MiddleBasicBlock);
526 }
527 VPBlockUtils::disconnectBlocks(Region1, MiddleBasicBlock);
528 TransformedRegions.insert(Region1);
529 }
530
531 return !TransformedRegions.empty();
532}
533
535 VPRegionBlock *ParentRegion,
536 VPlan &Plan) {
537 Instruction *Instr = PredRecipe->getUnderlyingInstr();
538 // Build the triangular if-then region.
539 std::string RegionName = (Twine("pred.") + Instr->getOpcodeName()).str();
540 assert(Instr->getParent() && "Predicated instruction not in any basic block");
541 auto *BlockInMask = PredRecipe->getMask();
542 auto *MaskDef = BlockInMask->getDefiningRecipe();
543 auto *BOMRecipe = new VPBranchOnMaskRecipe(
544 BlockInMask, MaskDef ? MaskDef->getDebugLoc() : DebugLoc::getUnknown());
545 auto *Entry =
546 Plan.createVPBasicBlock(Twine(RegionName) + ".entry", BOMRecipe);
547
548 // Replace predicated replicate recipe with a replicate recipe without a
549 // mask but in the replicate region.
550 auto *RecipeWithoutMask = new VPReplicateRecipe(
551 PredRecipe->getUnderlyingInstr(), PredRecipe->operandsWithoutMask(),
552 PredRecipe->isSingleScalar(), nullptr /*Mask*/, *PredRecipe, *PredRecipe,
553 PredRecipe->getDebugLoc());
554 auto *Pred =
555 Plan.createVPBasicBlock(Twine(RegionName) + ".if", RecipeWithoutMask);
556 auto *Exiting = Plan.createVPBasicBlock(Twine(RegionName) + ".continue");
558 Plan.createReplicateRegion(Entry, Exiting, RegionName);
559
560 // Note: first set Entry as region entry and then connect successors starting
561 // from it in order, to propagate the "parent" of each VPBasicBlock.
562 Region->setParent(ParentRegion);
563 VPBlockUtils::insertTwoBlocksAfter(Pred, Exiting, Entry);
564 VPBlockUtils::connectBlocks(Pred, Exiting);
565
566 if (!PredRecipe->user_empty()) {
567 auto *PHIRecipe = new VPPredInstPHIRecipe(RecipeWithoutMask,
568 RecipeWithoutMask->getDebugLoc());
569 Exiting->appendRecipe(PHIRecipe);
570 PredRecipe->replaceAllUsesWith(PHIRecipe);
571 }
572 PredRecipe->eraseFromParent();
573 return Region;
574}
575
576static void addReplicateRegions(VPlan &Plan) {
579 vp_depth_first_deep(Plan.getEntry()))) {
580 for (VPRecipeBase &R : *VPBB)
581 if (auto *RepR = dyn_cast<VPReplicateRecipe>(&R)) {
582 if (RepR->isPredicated())
583 WorkList.push_back(RepR);
584 }
585 }
586
587 unsigned BBNum = 0;
588 for (VPReplicateRecipe *RepR : WorkList) {
589 VPBasicBlock *CurrentBlock = RepR->getParent();
590 VPBasicBlock *SplitBlock = CurrentBlock->splitAt(RepR->getIterator());
591
592 BasicBlock *OrigBB = RepR->getUnderlyingInstr()->getParent();
593 SplitBlock->setName(
594 OrigBB->hasName() ? OrigBB->getName() + "." + Twine(BBNum++) : "");
595 // Record predicated instructions for above packing optimizations.
597 createReplicateRegion(RepR, CurrentBlock->getParent(), Plan);
599
600 VPRegionBlock *ParentRegion = Region->getParent();
601 if (ParentRegion && ParentRegion->getExiting() == CurrentBlock)
602 ParentRegion->setExiting(SplitBlock);
603 }
604}
605
609 vp_depth_first_deep(Plan.getEntry()))) {
610 // Don't fold the blocks in the skeleton of the Plan into their single
611 // predecessors for now.
612 // TODO: Remove restriction once more of the skeleton is modeled in VPlan.
613 if (!VPBB->getParent())
614 continue;
615 auto *PredVPBB =
616 dyn_cast_or_null<VPBasicBlock>(VPBB->getSinglePredecessor());
617 if (!PredVPBB || PredVPBB->getNumSuccessors() != 1 ||
618 isa<VPIRBasicBlock>(PredVPBB))
619 continue;
620 WorkList.push_back(VPBB);
621 }
622
623 for (VPBasicBlock *VPBB : WorkList) {
624 VPBasicBlock *PredVPBB = cast<VPBasicBlock>(VPBB->getSinglePredecessor());
625 for (VPRecipeBase &R : make_early_inc_range(*VPBB))
626 R.moveBefore(*PredVPBB, PredVPBB->end());
627 VPBlockUtils::disconnectBlocks(PredVPBB, VPBB);
628 auto *ParentRegion = VPBB->getParent();
629 if (ParentRegion && ParentRegion->getExiting() == VPBB)
630 ParentRegion->setExiting(PredVPBB);
631 VPBlockUtils::transferSuccessors(VPBB, PredVPBB);
632 // VPBB is now dead and will be cleaned up when the plan gets destroyed.
633 }
634 return !WorkList.empty();
635}
636
638 // Convert masked VPReplicateRecipes to if-then region blocks.
640
641 bool ShouldSimplify = true;
642 while (ShouldSimplify) {
643 ShouldSimplify = sinkScalarOperands(Plan);
644 ShouldSimplify |= mergeReplicateRegionsIntoSuccessors(Plan);
645 ShouldSimplify |= mergeBlocksIntoPredecessors(Plan);
646 }
647}
648
649/// Remove redundant casts of inductions.
650///
651/// Such redundant casts are casts of induction variables that can be ignored,
652/// because we already proved that the casted phi is equal to the uncasted phi
653/// in the vectorized loop. There is no need to vectorize the cast - the same
654/// value can be used for both the phi and casts in the vector loop.
656 for (auto &Phi : Plan.getVectorLoopRegion()->getEntryBasicBlock()->phis()) {
658 if (!IV || IV->getTruncInst())
659 continue;
660
661 // A sequence of IR Casts has potentially been recorded for IV, which
662 // *must be bypassed* when the IV is vectorized, because the vectorized IV
663 // will produce the desired casted value. This sequence forms a def-use
664 // chain and is provided in reverse order, ending with the cast that uses
665 // the IV phi. Search for the recipe of the last cast in the chain and
666 // replace it with the original IV. Note that only the final cast is
667 // expected to have users outside the cast-chain and the dead casts left
668 // over will be cleaned up later.
669 ArrayRef<Instruction *> Casts = IV->getInductionDescriptor().getCastInsts();
670 VPValue *FindMyCast = IV;
671 for (Instruction *IRCast : reverse(Casts)) {
672 VPSingleDefRecipe *FoundUserCast = nullptr;
673 for (auto *U : FindMyCast->users()) {
674 auto *UserCast = dyn_cast<VPSingleDefRecipe>(U);
675 if (UserCast && UserCast->getUnderlyingValue() == IRCast) {
676 FoundUserCast = UserCast;
677 break;
678 }
679 }
680 // A cast recipe in the chain may have been removed by earlier DCE.
681 if (!FoundUserCast)
682 break;
683 FindMyCast = FoundUserCast;
684 }
685 if (FindMyCast != IV)
686 FindMyCast->replaceAllUsesWith(IV);
687 }
688}
689
692 Plan.getEntry());
694 // The recipes in the block are processed in reverse order, to catch chains
695 // of dead recipes.
696 for (VPRecipeBase &R : make_early_inc_range(reverse(*VPBB))) {
697 if (vputils::isDeadRecipe(R)) {
698 R.eraseFromParent();
699 continue;
700 }
701
702 // Check if R is a dead VPPhi <-> update cycle and remove it.
703 VPValue *Start, *Incoming;
704 if (!match(&R, m_VPPhi(m_VPValue(Start), m_VPValue(Incoming))))
705 continue;
706 auto *PhiR = cast<VPPhi>(&R);
707 VPUser *PhiUser = PhiR->getSingleUser();
708 if (!PhiUser)
709 continue;
710 if (PhiUser != Incoming->getDefiningRecipe() ||
711 Incoming->getNumUsers() != 1)
712 continue;
713 PhiR->replaceAllUsesWith(Start);
714 PhiR->eraseFromParent();
715 Incoming->getDefiningRecipe()->eraseFromParent();
716 }
717 }
718}
719
720/// Legalize VPWidenPointerInductionRecipe, by replacing it with a PtrAdd
721/// (IndStart, ScalarIVSteps (0, Step)) if only its scalar values are used, as
722/// VPWidenPointerInductionRecipe will generate vectors only. If some users
723/// require vectors while other require scalars, the scalar uses need to extract
724/// the scalars from the generated vectors (Note that this is different to how
725/// int/fp inductions are handled). Legalize extract-from-ends using uniform
726/// VPReplicateRecipe of wide inductions to use regular VPReplicateRecipe, so
727/// the correct end value is available. Also optimize
728/// VPWidenIntOrFpInductionRecipe, if any of its users needs scalar values, by
729/// providing them scalar steps built on the canonical scalar IV and update the
730/// original IV's users. This is an optional optimization to reduce the needs of
731/// vector extracts.
734 bool HasOnlyVectorVFs = !Plan.hasScalarVFOnly();
735
737 for (VPRecipeBase &Phi : HeaderVPBB->phis())
738 if (auto *PhiR = dyn_cast<VPWidenInductionRecipe>(&Phi))
739 WideIVs.push_back(PhiR);
740
741 // Try to narrow wide and replicating recipes to uniform recipes, based on
742 // VPlan analysis.
743 // TODO: Apply to all recipes in the future, to replace legacy uniformity
744 // analysis.
745 for (VPWidenInductionRecipe *PhiR : WideIVs) {
747 for (VPUser *U : reverse(Users)) {
748 auto *Def = dyn_cast<VPRecipeWithIRFlags>(U);
749 auto *RepR = dyn_cast<VPReplicateRecipe>(U);
750 // Skip recipes that shouldn't be narrowed.
751 if (!Def || !isa<VPReplicateRecipe, VPWidenRecipe>(Def) ||
752 Def->user_empty() || !Def->getUnderlyingValue() ||
753 (RepR && (RepR->isSingleScalar() || RepR->isPredicated())))
754 continue;
755
756 // Skip recipes that may have other lanes than their first used.
758 continue;
759
760 // TODO: Support scalarizing ExtractValue.
761 if (match(Def,
763 continue;
764
766 Def->getUnderlyingInstr()->getOpcode(), Def->operands(),
767 /*Mask=*/nullptr, *Def, {}, DebugLoc::getUnknown(),
768 Def->getUnderlyingInstr());
769 Clone->insertAfter(Def);
770 Def->replaceAllUsesWith(Clone);
771 Def->eraseFromParent();
772 }
773 }
774
775 VPBuilder Builder(HeaderVPBB, HeaderVPBB->getFirstNonPhi());
776 for (VPWidenInductionRecipe *PhiR : WideIVs) {
777 // Replace wide pointer inductions which have only their scalars used by
778 // PtrAdd(IndStart, ScalarIVSteps (0, Step)).
779 if (auto *PtrIV = dyn_cast<VPWidenPointerInductionRecipe>(PhiR)) {
780 if (!Plan.hasScalarVFOnly() &&
781 !PtrIV->onlyScalarsGenerated(Plan.hasScalableVF()))
782 continue;
783
784 VPValue *PtrAdd =
785 vputils::scalarizeVPWidenPointerInduction(PtrIV, Plan, Builder);
786 PtrIV->replaceAllUsesWith(PtrAdd);
787 continue;
788 }
789
790 // Replace widened induction with scalar steps for users that only use
791 // scalars.
792 auto *WideIV = cast<VPWidenIntOrFpInductionRecipe>(PhiR);
793 if (HasOnlyVectorVFs && none_of(WideIV->users(), [WideIV](VPUser *U) {
794 return U->usesScalars(WideIV);
795 }))
796 continue;
797
798 const InductionDescriptor &ID = WideIV->getInductionDescriptor();
799 VPIRFlags::WrapFlagsTy WrapFlags;
800 // We can preserve nuw when the step is non-negative.
801 const APInt *Step;
802 if (match(WideIV->getStepValue(), m_APInt(Step)) && Step->isNonNegative())
803 WrapFlags = {static_cast<bool>(WideIV->getNoWrapFlagsOrNone().HasNUW),
804 false};
806 Plan, ID.getKind(), ID.getInductionOpcode(),
807 dyn_cast_or_null<FPMathOperator>(ID.getInductionBinOp()),
808 WideIV->getTruncInst(), WideIV->getStartValue(), WideIV->getStepValue(),
809 WideIV->getDebugLoc(), Builder, WrapFlags);
810
811 // Update scalar users of IV to use Step instead.
812 if (!HasOnlyVectorVFs) {
813 assert(!Plan.hasScalableVF() &&
814 "plans containing a scalar VF cannot also include scalable VFs");
815 WideIV->replaceAllUsesWith(Steps);
816 } else {
817 bool HasScalableVF = Plan.hasScalableVF();
818 WideIV->replaceUsesWithIf(Steps,
819 [WideIV, HasScalableVF](VPUser &U, unsigned) {
820 if (HasScalableVF)
821 return U.usesFirstLaneOnly(WideIV);
822 return U.usesScalars(WideIV);
823 });
824 }
825 }
826}
827
828/// Check if \p VPV is an untruncated wide induction, either before or after the
829/// increment. If so return the header IV (before the increment), otherwise
830/// return null.
833 auto *WideIV = dyn_cast<VPWidenInductionRecipe>(VPV);
834 if (WideIV) {
835 // VPV itself is a wide induction, separately compute the end value for exit
836 // users if it is not a truncated IV.
837 auto *IntOrFpIV = dyn_cast<VPWidenIntOrFpInductionRecipe>(WideIV);
838 return (IntOrFpIV && IntOrFpIV->getTruncInst()) ? nullptr : WideIV;
839 }
840
841 // Check if VPV is an optimizable induction increment.
842 VPRecipeBase *Def = VPV->getDefiningRecipe();
843 if (!Def || Def->getNumOperands() != 2)
844 return nullptr;
845 WideIV = dyn_cast<VPWidenInductionRecipe>(Def->getOperand(0));
846 if (!WideIV)
847 WideIV = dyn_cast<VPWidenInductionRecipe>(Def->getOperand(1));
848 if (!WideIV)
849 return nullptr;
850
851 auto IsWideIVInc = [&]() {
852 auto &ID = WideIV->getInductionDescriptor();
853
854 // Check if VPV increments the induction by the induction step.
855 VPValue *IVStep = WideIV->getStepValue();
856 switch (ID.getInductionOpcode()) {
857 case Instruction::Add:
858 return match(VPV, m_c_Add(m_Specific(WideIV), m_Specific(IVStep)));
859 case Instruction::FAdd:
860 return match(VPV, m_c_FAdd(m_Specific(WideIV), m_Specific(IVStep)));
861 case Instruction::FSub:
862 return match(VPV, m_Binary<Instruction::FSub>(m_Specific(WideIV),
863 m_Specific(IVStep)));
864 case Instruction::Sub: {
865 // IVStep will be the negated step of the subtraction. Check if Step == -1
866 // * IVStep.
867 VPValue *Step;
868 if (!match(VPV, m_Sub(m_VPValue(), m_VPValue(Step))))
869 return false;
870 const SCEV *IVStepSCEV = vputils::getSCEVExprForVPValue(IVStep, PSE);
871 const SCEV *StepSCEV = vputils::getSCEVExprForVPValue(Step, PSE);
872 ScalarEvolution &SE = *PSE.getSE();
873 return !isa<SCEVCouldNotCompute>(IVStepSCEV) &&
874 !isa<SCEVCouldNotCompute>(StepSCEV) &&
875 IVStepSCEV == SE.getNegativeSCEV(StepSCEV);
876 }
877 default:
878 return ID.getKind() == InductionDescriptor::IK_PtrInduction &&
879 match(VPV, m_GetElementPtr(m_Specific(WideIV),
880 m_Specific(WideIV->getStepValue())));
881 }
882 llvm_unreachable("should have been covered by switch above");
883 };
884 return IsWideIVInc() ? WideIV : nullptr;
885}
886
887/// Attempts to optimize the induction variable exit values for users in the
888/// early exit block.
891 VPValue *Incoming, *Mask;
893 m_VPValue(Incoming))))
894 return nullptr;
895
896 auto *WideIV = getOptimizableIVOf(Incoming, PSE);
897 if (!WideIV)
898 return nullptr;
899
900 // Calculate the final index.
901 VPRegionBlock *LoopRegion = Plan.getVectorLoopRegion();
902 auto *CanonicalIV = LoopRegion->getCanonicalIV();
903 Type *CanonicalIVType = LoopRegion->getCanonicalIVType();
904 auto *ExtractR = cast<VPInstruction>(Op);
905 VPBuilder B(ExtractR);
906
907 DebugLoc DL = ExtractR->getDebugLoc();
908 VPValue *FirstActiveLane = B.createFirstActiveLane(Mask, DL);
909 FirstActiveLane =
910 B.createScalarZExtOrTrunc(FirstActiveLane, CanonicalIVType, DL);
911 VPValue *EndValue = B.createAdd(CanonicalIV, FirstActiveLane, DL);
912
913 // `getOptimizableIVOf()` always returns the pre-incremented IV, so if it
914 // changed it means the exit is using the incremented value, so we need to
915 // add the step.
916 if (Incoming != WideIV) {
917 VPValue *One = Plan.getConstantInt(CanonicalIVType, 1);
918 EndValue = B.createAdd(EndValue, One, DL);
919 }
920
921 if (!match(WideIV, m_CanonicalWidenIV())) {
922 const InductionDescriptor &ID = WideIV->getInductionDescriptor();
923 VPIRValue *Start = WideIV->getStartValue();
924 VPValue *Step = WideIV->getStepValue();
925 EndValue = B.createDerivedIV(
926 ID.getKind(), dyn_cast_or_null<FPMathOperator>(ID.getInductionBinOp()),
927 Start, EndValue, Step);
928 }
929
930 return EndValue;
931}
932
933/// Compute the end value for \p WideIV, unless it is truncated. Creates a
934/// VPDerivedIVRecipe for non-canonical inductions.
936 VPBuilder &VectorPHBuilder,
937 VPValue *VectorTC) {
938 auto *WideIntOrFp = dyn_cast<VPWidenIntOrFpInductionRecipe>(WideIV);
939 // Truncated wide inductions resume from the last lane of their vector value
940 // in the last vector iteration which is handled elsewhere.
941 if (WideIntOrFp && WideIntOrFp->getTruncInst())
942 return nullptr;
943
944 VPIRValue *Start = WideIV->getStartValue();
945 VPValue *Step = WideIV->getStepValue();
946 const InductionDescriptor &ID = WideIV->getInductionDescriptor();
947 VPValue *EndValue = VectorTC;
948 if (!match(WideIV, m_CanonicalWidenIV())) {
949 EndValue = VectorPHBuilder.createDerivedIV(
950 ID.getKind(), dyn_cast_or_null<FPMathOperator>(ID.getInductionBinOp()),
951 Start, VectorTC, Step);
952 }
953
954 // EndValue is derived from the vector trip count (which has the same type as
955 // the widest induction) and thus may be wider than the induction here.
956 Type *ScalarTypeOfWideIV = WideIV->getScalarType();
957 if (ScalarTypeOfWideIV != EndValue->getScalarType()) {
958 EndValue = VectorPHBuilder.createScalarCast(Instruction::Trunc, EndValue,
959 ScalarTypeOfWideIV,
960 WideIV->getDebugLoc());
961 }
962
963 return EndValue;
964}
965
966/// Attempts to optimize the induction variable exit values for users in the
967/// exit block coming from the latch in the original scalar loop.
968static VPValue *
972 VPValue *Incoming;
975 m_VPValue(Incoming)))))
976 return nullptr;
977
978 VPWidenInductionRecipe *WideIV = getOptimizableIVOf(Incoming, PSE);
979 if (!WideIV)
980 return nullptr;
981
982 VPValue *EndValue = EndValues.lookup(WideIV);
983 assert(EndValue && "Must have computed the end value up front");
984
985 // `getOptimizableIVOf()` always returns the pre-incremented IV, so if it
986 // changed it means the exit is using the incremented value, so we don't
987 // need to subtract the step.
988 if (Incoming != WideIV)
989 return EndValue;
990
991 // Otherwise, subtract the step from the EndValue.
992 auto *ExtractR = cast<VPInstruction>(Op);
993 VPBuilder B(ExtractR);
994 VPValue *Step = WideIV->getStepValue();
995 Type *ScalarTy = WideIV->getScalarType();
996 if (ScalarTy->isIntegerTy())
997 return B.createSub(EndValue, Step, DebugLoc::getUnknown(), "ind.escape");
998 if (ScalarTy->isPointerTy()) {
999 Type *StepTy = Step->getScalarType();
1000 auto *Zero = Plan.getZero(StepTy);
1001 return B.createPtrAdd(EndValue, B.createSub(Zero, Step),
1002 DebugLoc::getUnknown(), "ind.escape");
1003 }
1004 if (ScalarTy->isFloatingPointTy()) {
1005 const auto &ID = WideIV->getInductionDescriptor();
1006 return B.createNaryOp(
1007 ID.getInductionBinOp()->getOpcode() == Instruction::FAdd
1008 ? Instruction::FSub
1009 : Instruction::FAdd,
1010 {EndValue, Step}, {ID.getInductionBinOp()->getFastMathFlags()});
1011 }
1012 llvm_unreachable("all possible induction types must be handled");
1013 return nullptr;
1014}
1015
1018 VPValue *ResumeTC,
1019 const Loop *L) {
1020 VPValue *Incoming;
1022 return nullptr;
1023
1024 const SCEV *IncomingSCEV = vputils::getSCEVExprForVPValue(Incoming, PSE, L);
1025 const SCEV *Start, *Step;
1026 if (!match(IncomingSCEV, m_scev_AffineAddRec(m_SCEV(Start), m_SCEV(Step),
1027 m_SpecificLoop(L))))
1028 return nullptr;
1029
1030 auto *ExtractR = cast<VPInstruction>(Op);
1031 DebugLoc DL = ExtractR->getDebugLoc();
1032 VPBuilder Builder(ExtractR);
1033 VPSCEVExpander Expander(Builder, *PSE.getSE(), DL);
1034 VPValue *StartVPV = Expander.expand(Start);
1035 VPValue *StepVPV = Expander.expand(Step);
1036
1037 Type *StartTy = StartVPV->getScalarType();
1038 assert(StartTy->isIntOrPtrTy() && "The type must be SCEVable");
1042 Type *TCTy = ResumeTC->getScalarType();
1043 VPValue *ExitCount = Builder.createOverflowingOp(
1044 Instruction::Sub, {ResumeTC, Plan.getConstantInt(TCTy, 1)},
1045 {/*HasNUW=*/true, /*HasNSW=*/false}, DebugLoc::getUnknown());
1046 return Builder.createDerivedIV(Kind, /*FPBinOp=*/nullptr, StartVPV, ExitCount,
1047 StepVPV);
1048}
1049
1051 VPlan &Plan, PredicatedScalarEvolution &PSE, const Loop *L) {
1052 // Compute end values for all inductions.
1053 VPRegionBlock *VectorRegion = Plan.getVectorLoopRegion();
1054 auto *VectorPH = cast<VPBasicBlock>(VectorRegion->getSinglePredecessor());
1055 VPBuilder VectorPHBuilder(VectorPH, VectorPH->begin());
1057 VPValue *ResumeTC =
1058 Plan.hasTailFolded() ? Plan.getTripCount() : &Plan.getVectorTripCount();
1059 for (auto &Phi : VectorRegion->getEntryBasicBlock()->phis()) {
1060 auto *WideIV = dyn_cast<VPWidenInductionRecipe>(&Phi);
1061 if (!WideIV)
1062 continue;
1063 if (VPValue *EndValue =
1064 tryToComputeEndValueForInduction(WideIV, VectorPHBuilder, ResumeTC))
1065 EndValues[WideIV] = EndValue;
1066 }
1067
1068 VPBasicBlock *MiddleVPBB = Plan.getMiddleBlock();
1069 for (VPRecipeBase &R : make_early_inc_range(*MiddleVPBB)) {
1070 VPValue *Op;
1071 if (!match(&R, m_ExitingIVValue(m_VPValue(Op))))
1072 continue;
1073 auto *WideIV = cast<VPWidenInductionRecipe>(Op);
1074 if (VPValue *EndValue = EndValues.lookup(WideIV)) {
1075 R.getVPSingleValue()->replaceAllUsesWith(EndValue);
1076 R.eraseFromParent();
1077 }
1078 }
1079
1080 // Then, optimize exit block users.
1081 for (VPIRBasicBlock *ExitVPBB : Plan.getExitBlocks()) {
1082 for (VPRecipeBase &R : ExitVPBB->phis()) {
1083 auto *ExitIRI = cast<VPIRPhi>(&R);
1084
1085 for (auto [Idx, PredVPBB] : enumerate(ExitVPBB->getPredecessors())) {
1086 VPValue *Escape = nullptr;
1087 if (PredVPBB == MiddleVPBB) {
1089 Plan, ExitIRI->getOperand(Idx), EndValues, PSE);
1090 if (!Escape)
1092 Plan, ExitIRI->getOperand(Idx), PSE, ResumeTC, L);
1093 } else {
1095 Plan, ExitIRI->getOperand(Idx), PSE);
1096 }
1097 if (Escape)
1098 ExitIRI->setOperand(Idx, Escape);
1099 }
1100 }
1101 }
1102}
1103
1104/// Remove redundant ExpandSCEVRecipes in \p Plan's entry block by replacing
1105/// them with already existing recipes expanding the same SCEV expression.
1108
1109 for (VPRecipeBase &R :
1111 auto *ExpR = dyn_cast<VPExpandSCEVRecipe>(&R);
1112 if (!ExpR)
1113 continue;
1114
1115 const auto &[V, Inserted] = SCEV2VPV.try_emplace(ExpR->getSCEV(), ExpR);
1116 if (Inserted)
1117 continue;
1118
1119 ExpR->replaceAllUsesWith(V->second);
1120 if (ExpR == Plan.getTripCount())
1121 Plan.resetTripCount(V->second);
1122
1123 ExpR->eraseFromParent();
1124 }
1125}
1126
1127/// Try to simplify logical and bitwise recipes in \p Def.
1129 VPBuilder &Builder,
1130 bool CanCreateNewRecipe) {
1131 VPlan *Plan = Def->getParent()->getPlan();
1132
1133 // Simplify (X && Y) | (X && !Y) -> X.
1134 // TODO: Split up into simpler, modular combines: (X && Y) | (X && Z) into X
1135 // && (Y | Z) and (X | !X) into true. This requires queuing newly created
1136 // recipes to be visited during simplification.
1137 VPValue *X, *Y, *Z;
1138 if (match(Def,
1141 return X;
1142
1143 // x | AllOnes -> AllOnes
1144 if (match(Def, m_c_BinaryOr(m_VPValue(X), m_AllOnes())))
1145 return Plan->getAllOnesValue(Def->getScalarType());
1146
1147 // x | 0 -> x
1148 if (match(Def, m_c_BinaryOr(m_VPValue(X), m_ZeroInt())))
1149 return X;
1150
1151 // x | !x -> AllOnes
1153 return Plan->getAllOnesValue(Def->getScalarType());
1154
1155 // x & 0 -> 0
1156 if (match(Def, m_c_BinaryAnd(m_VPValue(X), m_ZeroInt())))
1157 return Plan->getZero(Def->getScalarType());
1158
1159 // x & AllOnes -> x
1160 if (match(Def, m_c_BinaryAnd(m_VPValue(X), m_AllOnes())))
1161 return X;
1162
1163 // x && false -> false
1164 if (match(Def, m_c_LogicalAnd(m_VPValue(X), m_False())))
1165 return Plan->getFalse();
1166
1167 // x && true -> x
1168 if (match(Def, m_c_LogicalAnd(m_VPValue(X), m_True())))
1169 return X;
1170
1171 // (x && y) | (x && z) -> x && (y | z)
1172 if (CanCreateNewRecipe &&
1175 // Simplify only if one of the operands has one use to avoid creating an
1176 // extra recipe.
1177 (!Def->getOperand(0)->hasMoreThanOneUniqueUser() ||
1178 !Def->getOperand(1)->hasMoreThanOneUniqueUser()))
1179 return Builder.createLogicalAnd(X, Builder.createOr(Y, Z));
1180
1181 // x && (x && y) -> x && y
1182 if (match(Def, m_LogicalAnd(m_VPValue(X),
1184 return Def->getOperand(1);
1185
1186 // x && (y && x) -> x && y
1187 if (match(Def, m_LogicalAnd(m_VPValue(X),
1189 return Builder.createLogicalAnd(X, Y);
1190
1191 // x && !x -> 0
1193 return Plan->getFalse();
1194
1195 if (match(Def, m_Select(m_VPValue(), m_VPValue(X), m_Deferred(X))))
1196 return X;
1197
1198 // select c, false, true -> not c
1199 VPValue *C;
1200 if (CanCreateNewRecipe &&
1201 match(Def, m_Select(m_VPValue(C), m_False(), m_True())))
1202 return Builder.createNot(C);
1203
1204 // select !c, x, y -> select c, y, x
1205 if (match(Def, m_Select(m_Not(m_VPValue(C)), m_VPValue(X), m_VPValue(Y)))) {
1206 Def->setOperand(0, C);
1207 Def->setOperand(1, Y);
1208 Def->setOperand(2, X);
1209 return Def;
1210 }
1211
1212 // select x, (i1 y | z), y -> y | (x && z)
1213 if (CanCreateNewRecipe &&
1214 match(Def, m_Select(m_VPValue(X),
1216 m_Deferred(Y))) &&
1217 Y->getScalarType()->isIntegerTy(1))
1218 return Builder.createOr(Y, Builder.createLogicalAnd(X, Z));
1219
1220 // select %M0, (select %M1, %X, %Y), %Y -> select (%M0 && %M1), %X, %Y
1221 VPValue *Mask0, *Mask1;
1222 if (CanCreateNewRecipe &&
1223 match(Def,
1224 m_SelectLike(m_VPValue(Mask0),
1226 m_VPValue(Y))),
1227 m_Deferred(Y))))
1228 return Builder.createSelect(Builder.createLogicalAnd(Mask0, Mask1), X, Y,
1229 Def->getDebugLoc());
1230
1231 return nullptr;
1232}
1233
1234/// Try to simplify VPSingleDefRecipe \p Def. Returns a new recipe if it should
1235/// be replaced, or the existing recipe if it was modified. Returns nullptr if
1236/// nothing was simplified.
1238 VPlan *Plan = Def->getParent()->getPlan();
1239
1240 // Simplification of live-in IR values for SingleDef recipes using
1241 // InstSimplifyFolder.
1242 const DataLayout &DL = Plan->getDataLayout();
1243 if (VPValue *V = vputils::tryToFoldLiveIns(*Def, Def->operands(), DL))
1244 return V;
1245
1246 // Fold PredPHI LiveIn -> LiveIn.
1247 if (auto *PredPHI = dyn_cast<VPPredInstPHIRecipe>(Def)) {
1248 VPValue *Op = PredPHI->getOperand(0);
1249 if (isa<VPIRValue>(Op))
1250 return Op;
1251 }
1252
1253 // Drop the mask of a predicated store masked by the header mask (which is
1254 // guaranteed to be true at least for the first lane) and both the stored
1255 // value and the address are uniform across VF and UF. The header mask is
1256 // still the abstract region value here.
1257 if (auto *RepR = dyn_cast<VPReplicateRecipe>(Def);
1258 RepR && RepR->isPredicated() && RepR->getOpcode() == Instruction::Store &&
1259 all_of(RepR->operandsWithoutMask(), vputils::isUniformAcrossVFsAndUFs) &&
1260 match(RepR->getMask(), m_HeaderMask())) {
1261 auto *Unmasked = new VPReplicateRecipe(
1262 RepR->getUnderlyingInstr(), RepR->operandsWithoutMask(),
1263 RepR->isSingleScalar(), /*Mask=*/nullptr, *RepR, *RepR,
1264 RepR->getDebugLoc());
1265 Unmasked->insertBefore(RepR);
1266 return Unmasked;
1267 }
1268
1269 VPBuilder Builder(Def);
1270
1271 // Avoid replacing VPInstructions with underlying values with new
1272 // VPInstructions, as we would fail to create widen/replicate recpes from the
1273 // new VPInstructions without an underlying value, and miss out on some
1274 // transformations that only apply to widened/replicated recipes later, by
1275 // doing so.
1276 // TODO: We should also not replace non-VPInstructions like VPWidenRecipe with
1277 // VPInstructions without underlying values, as those will get skipped during
1278 // cost computation.
1279 bool CanCreateNewRecipe =
1280 !isa<VPInstruction>(Def) || !Def->getUnderlyingValue();
1281
1282 VPValue *A, *Z;
1283 if (match(Def, m_Trunc(m_VPValue(Z, m_ZExtOrSExt(m_VPValue(A)))))) {
1284 Type *TruncTy = Def->getScalarType();
1285 Type *ATy = A->getScalarType();
1286 if (TruncTy == ATy) {
1287 return A;
1288 } else {
1289 // Don't replace a non-widened cast recipe with a widened cast.
1290 if (!isa<VPWidenCastRecipe>(Def))
1291 return nullptr;
1292 if (ATy->getScalarSizeInBits() < TruncTy->getScalarSizeInBits()) {
1293
1294 unsigned ExtOpcode = match(Z, m_SExt(m_VPValue())) ? Instruction::SExt
1295 : Instruction::ZExt;
1296 auto *Ext = Builder.createWidenCast(Instruction::CastOps(ExtOpcode), A,
1297 TruncTy);
1298 if (auto *UnderlyingExt = Z->getUnderlyingValue()) {
1299 // UnderlyingExt has distinct return type, used to retain legacy cost.
1300 Ext->setUnderlyingValue(UnderlyingExt);
1301 }
1302 return Ext;
1303 } else if (ATy->getScalarSizeInBits() > TruncTy->getScalarSizeInBits()) {
1304 auto *Trunc = Builder.createWidenCast(Instruction::Trunc, A, TruncTy);
1305 return Trunc;
1306 }
1307 }
1308 }
1309
1310 if (VPValue *V = simplifyLogicalRecipe(Def, Builder, CanCreateNewRecipe))
1311 return V;
1312
1313 VPValue *X, *Y;
1314 if (match(Def, m_c_Add(m_VPValue(A), m_ZeroInt())))
1315 return A;
1316
1317 if (match(Def, m_c_Mul(m_VPValue(A), m_One())))
1318 return A;
1319
1320 if (match(Def, m_c_Mul(m_VPValue(A), m_ZeroInt())))
1321 return Plan->getZero(Def->getScalarType());
1322
1323 if (CanCreateNewRecipe && match(Def, m_c_Mul(m_VPValue(A), m_AllOnes()))) {
1324 // Preserve nsw from the Mul on the new Sub.
1326 false, cast<VPRecipeWithIRFlags>(Def)->hasNoSignedWrap()};
1327 return Builder.createSub(Plan->getZero(A->getScalarType()), A,
1328 Def->getDebugLoc(), "", NW);
1329 }
1330
1331 if (CanCreateNewRecipe &&
1332 match(Def, m_c_Add(m_VPValue(X),
1333 m_VPValue(Z, m_Sub(m_ZeroInt(), m_VPValue(Y)))))) {
1334 // Preserve nsw from the Add and the Sub, if it's present on both, on the
1335 // new Sub.
1337 false, cast<VPRecipeWithIRFlags>(Def)->hasNoSignedWrap() &&
1338 cast<VPRecipeWithIRFlags>(Z)->hasNoSignedWrap()};
1339 return Builder.createSub(X, Y, Def->getDebugLoc(), "", NW);
1340 }
1341
1342 const APInt *APC;
1343 if (CanCreateNewRecipe && match(Def, m_URem(m_VPValue(X), m_APInt(APC))) &&
1344 APC->isPowerOf2())
1345 return Builder.createAnd(X, Plan->getConstantInt(*APC - 1),
1346 Def->getDebugLoc());
1347
1348 if (CanCreateNewRecipe && match(Def, m_c_Mul(m_VPValue(A), m_APInt(APC))) &&
1349 APC->isPowerOf2()) {
1350 auto *MulR = cast<VPRecipeWithIRFlags>(Def);
1351 unsigned ShiftAmt = APC->exactLogBase2();
1352 VPIRFlags::WrapFlagsTy NW(MulR->hasNoUnsignedWrap(),
1353 MulR->hasNoSignedWrap() &&
1354 ShiftAmt != APC->getBitWidth() - 1);
1355 return Builder.createNaryOp(
1356 Instruction::Shl,
1357 {A, Plan->getConstantInt(APC->getBitWidth(), ShiftAmt)}, NW,
1358 Def->getDebugLoc());
1359 }
1360
1361 if (CanCreateNewRecipe && match(Def, m_UDiv(m_VPValue(A), m_APInt(APC))) &&
1362 APC->isPowerOf2())
1363 return Builder.createNaryOp(
1364 Instruction::LShr,
1365 {A, Plan->getConstantInt(APC->getBitWidth(), APC->exactLogBase2())},
1366 *cast<VPRecipeWithIRFlags>(Def), Def->getDebugLoc());
1367
1368 if (match(Def, m_Not(m_VPValue(A)))) {
1369 if (match(A, m_Not(m_VPValue(A))))
1370 return A;
1371
1372 // Try to fold Not into compares by adjusting the predicate in-place.
1373 CmpPredicate Pred;
1374 if (match(A, m_Cmp(Pred, m_VPValue(), m_VPValue()))) {
1375 auto *Cmp = cast<VPRecipeWithIRFlags>(A);
1376 // Only fold if every user is a Not of the cmp, or a select using the cmp
1377 // solely as its condition.
1378 if (all_of(Cmp->users(), [Cmp](VPUser *U) {
1379 return match(U, m_Not(m_Specific(Cmp))) ||
1380 (match(U, m_Select(m_Specific(Cmp), m_VPValue(),
1381 m_VPValue())) &&
1382 U->getOperand(1) != Cmp && U->getOperand(2) != Cmp);
1383 })) {
1384 Cmp->setPredicate(CmpInst::getInversePredicate(Pred));
1385 for (VPUser *U : to_vector(Cmp->users())) {
1386 auto *R = cast<VPSingleDefRecipe>(U);
1387 if (match(R, m_Select(m_Specific(Cmp), m_VPValue(X), m_VPValue(Y)))) {
1388 // select (cmp pred), x, y -> select (cmp inv_pred), y, x
1389 R->setOperand(1, Y);
1390 R->setOperand(2, X);
1391 } else {
1392 // not (cmp pred) -> cmp inv_pred
1393 assert(match(R, m_Not(m_Specific(Cmp))) && "Unexpected user");
1394 R->replaceAllUsesWith(Cmp);
1395 }
1396 }
1397 // If Cmp doesn't have a debug location, use the one from the negation,
1398 // to preserve the location.
1399 if (!Cmp->getDebugLoc() && Def->getDebugLoc())
1400 Cmp->setDebugLoc(Def->getDebugLoc());
1401 return Def;
1402 }
1403 }
1404 }
1405
1406 // Fold any-of (fcmp uno %A, %A), (fcmp uno %B, %B), ... ->
1407 // any-of (fcmp uno %A, %B), ...
1408 if (match(Def, m_AnyOf())) {
1410 VPRecipeBase *UnpairedCmp = nullptr;
1411 for (VPValue *Op : Def->operands()) {
1412 VPValue *X;
1413 if (Op->getNumUsers() > 1 ||
1415 m_Deferred(X)))) {
1416 NewOps.push_back(Op);
1417 } else if (!UnpairedCmp) {
1418 UnpairedCmp = Op->getDefiningRecipe();
1419 } else {
1420 NewOps.push_back(Builder.createFCmp(CmpInst::FCMP_UNO,
1421 UnpairedCmp->getOperand(0), X));
1422 UnpairedCmp = nullptr;
1423 }
1424 }
1425
1426 if (UnpairedCmp)
1427 NewOps.push_back(UnpairedCmp->getVPSingleValue());
1428
1429 if (NewOps.size() < Def->getNumOperands()) {
1430 VPValue *NewAnyOf = Builder.createNaryOp(VPInstruction::AnyOf, NewOps);
1431 return NewAnyOf;
1432 }
1433 }
1434
1435 // Fold (fcmp uno %X, %X) or (fcmp uno %Y, %Y) -> fcmp uno %X, %Y
1436 // This is useful for fmax/fmin without fast-math flags, where we need to
1437 // check if any operand is NaN.
1438 if (CanCreateNewRecipe &&
1439 match(Def,
1440 m_BinaryOr(
1443 return Builder.createFCmp(CmpInst::FCMP_UNO, X, Y);
1444
1445 // Remove redundant DerviedIVs, that is 0 + A * 1 -> A and 0 + 0 * x -> 0.
1446 if ((match(Def, m_DerivedIV(m_ZeroInt(), m_VPValue(A), m_One())) ||
1448 m_VPValue()))) &&
1449 A->getScalarType() == Def->getScalarType())
1450 return A;
1451
1453 m_One()))) {
1454 Type *WideStepTy = Def->getScalarType();
1455 if (X->getScalarType() != WideStepTy)
1456 X = Builder.createWidenCast(Instruction::Trunc, X, WideStepTy);
1457 return X;
1458 }
1459
1460 // For i1 vp.merges produced by AnyOf reductions:
1461 // vp.merge true, (or x, y), x, evl -> vp.merge y, true, x, evl
1463 m_VPValue(X), m_VPValue())) &&
1465 Def->getScalarType()->isIntegerTy(1)) {
1466 Def->setOperand(1, Plan->getTrue());
1467 Def->setOperand(0, Y);
1468 return Def;
1469 }
1470
1471 // Simplify MaskedCond with no block mask to its single operand.
1473 !cast<VPInstruction>(Def)->isMasked())
1474 return Def->getOperand(0);
1475
1476 // Look through ExtractLastLane.
1477 if (match(Def, m_ExtractLastLane(m_VPValue(A)))) {
1478 if (match(A, m_BuildVector())) {
1479 auto *BuildVector = cast<VPInstruction>(A);
1480 return BuildVector->getOperand(BuildVector->getNumOperands() - 1);
1481 }
1482
1483 if (match(A, m_Broadcast(m_VPValue(X))))
1484 return X;
1485
1487 return A;
1488
1489 if (Plan->hasScalarVFOnly())
1490 return A;
1491 }
1492
1493 // Look through ExtractPenultimateElement (BuildVector ....).
1495 auto *BuildVector = cast<VPInstruction>(Def->getOperand(0));
1496 return BuildVector->getOperand(BuildVector->getNumOperands() - 2);
1497 }
1498
1499 uint64_t Idx;
1501 auto *BuildVector = cast<VPInstruction>(Def->getOperand(0));
1502 return BuildVector->getOperand(Idx);
1503 }
1504
1505 if (match(Def, m_BuildVector()) && all_equal(Def->operands()))
1506 return Builder.createNaryOp(VPInstruction::Broadcast, Def->getOperand(0));
1507
1508 // Replace uses of a BuildVector by users that only use its first lane with
1509 // its first operand directly.
1510 if (match(Def, m_BuildVector())) {
1511 Def->replaceUsesWithIf(Def->getOperand(0), [Def](VPUser &U, unsigned) {
1512 return U.usesFirstLaneOnly(Def);
1513 });
1514 return Def;
1515 }
1516
1517 // Look through broadcast of single-scalar when used as select conditions; in
1518 // that case the scalar condition can be used directly.
1519 if (match(Def,
1522 "broadcast operand must be single-scalar");
1523 Def->setOperand(0, Z);
1524 return Def;
1525 }
1526
1527 if (match(Def, m_Broadcast(m_VPValue(X)))) {
1528 Def->replaceUsesWithIf(
1529 X, [Def](const VPUser &U, unsigned) { return U.usesScalars(Def); });
1530 return Def;
1531 }
1532
1534 if (Def->getNumOperands() == 1) {
1535 return Def->getOperand(0);
1536 }
1537 if (auto *Phi = dyn_cast<VPFirstOrderRecurrencePHIRecipe>(Def)) {
1538 if (all_equal(Phi->incoming_values()))
1539 return Phi->getOperand(0);
1540 }
1541 return nullptr;
1542 }
1543
1544 VPIRValue *IRV;
1545 if (Def->getNumOperands() == 1 &&
1547 return IRV;
1548
1549 // Some simplifications can only be applied after unrolling. Perform them
1550 // below.
1551 if (!Plan->isUnrolled())
1552 return nullptr;
1553
1554 // After unrolling, extract-lane may be used to extract values from multiple
1555 // scalar sources. Only simplify when extracting from a single scalar source.
1556 VPValue *LaneToExtract;
1557 if (match(Def, m_ExtractLane(m_VPValue(LaneToExtract), m_VPValue(A)))) {
1558 // Simplify extract-lane(%lane_num, %scalar_val) -> %scalar_val.
1560 return A;
1561
1562 // Replace extract-lane(0, canonical-WIDEN-INDUCTION) with the region's
1563 // scalar canonical IV.
1565 if (match(LaneToExtract, m_ZeroInt()) &&
1566 match(A, m_CanonicalWidenIV(WidenIV)))
1567 return WidenIV->getRegion()->getCanonicalIV();
1568
1569 // Simplify extract-lane with single source to extract-element.
1570 return Builder.createNaryOp(Instruction::ExtractElement, {A, LaneToExtract},
1571 Def->getDebugLoc());
1572 }
1573
1574 // Look for cycles where Def is of the form:
1575 // X = phi(0, IVInc) ; used only by IVInc, or by IVInc and Inc = X + Y
1576 // IVInc = X + Step ; used by X and Def
1577 // Def = IVInc + Y
1578 // Fold the increment Y into the phi's start value, replace Def with IVInc,
1579 // and if Inc exists, replace it with X.
1580 VPValue *IVInc;
1581 if (match(Def, m_Add(m_VPValue(IVInc, m_Add(m_VPValue(X), m_VPValue())),
1582 m_VPValue(Y))) &&
1583 isa<VPIRValue>(Y) && match(X, m_VPPhi(m_ZeroInt(), m_Specific(IVInc)))) {
1584 auto *Phi = cast<VPPhi>(X);
1585 if (IVInc->getNumUsers() == 2) {
1586 // If Phi has a second user (besides IVInc's defining recipe), it must
1587 // be Inc = Phi + Y for the fold to apply.
1589 findUserOf(Phi, m_Add(m_Specific(Phi), m_Specific(Y))));
1590 if (Phi->getNumUsers() == 1 || (Phi->getNumUsers() == 2 && Inc)) {
1591 Def->replaceAllUsesWith(IVInc);
1592 if (Inc)
1593 Inc->replaceAllUsesWith(Phi);
1594 Phi->setOperand(0, Y);
1595 return Def;
1596 }
1597 }
1598 }
1599
1600 // Simplify unrolled VectorPointer without offset, or with zero offset, to
1601 // just the pointer operand.
1602 if (auto *VPR = dyn_cast<VPVectorPointerRecipe>(Def))
1603 if (!VPR->getVFxPart() || match(VPR->getVFxPart(), m_ZeroInt()))
1604 return VPR->getOperand(0);
1605
1606 // VPScalarIVSteps after unrolling can be replaced by their start value, if
1607 // the start index is zero and only the first lane 0 is demanded.
1608 if (auto *Steps = dyn_cast<VPScalarIVStepsRecipe>(Def))
1609 if (!Steps->getStartIndex() && vputils::onlyFirstLaneUsed(Steps))
1610 return Steps->getOperand(0);
1611
1612 // Simplify redundant ReductionStartVector recipes after unrolling.
1613 VPValue *StartV;
1615 m_VPValue(StartV), m_VPValue(), m_VPValue()))) {
1616 Def->replaceUsesWithIf(StartV, [](const VPUser &U, unsigned Idx) {
1617 auto *PhiR = dyn_cast<VPReductionPHIRecipe>(&U);
1618 return PhiR && PhiR->isInLoop();
1619 });
1620 return Def;
1621 }
1622
1623 if (Plan->getConcreteUF() == 1 && match(Def, m_ExtractLastPart(m_VPValue(A))))
1624 return A;
1625
1626 return nullptr;
1627}
1628
1631 Plan.getEntry());
1633 for (VPRecipeBase &R : make_early_inc_range(*VPBB))
1634 if (auto *Def = dyn_cast<VPSingleDefRecipe>(&R))
1635 if (VPValue *New = simplifyRecipe(Def)) {
1636 if (New != Def) {
1637 // Replace the recipe with a new one.
1638 Def->replaceAllUsesWith(New);
1639 Def->eraseFromParent();
1640 } else if (vputils::isDeadRecipe(R)) {
1641 // Recipe was modified - it may be dead now.
1642 Def->eraseFromParent();
1643 }
1644 }
1645 }
1646}
1647
1649 // Pull out reverses from any elementwise op.
1650 // binop(reverse(x), reverse(y)) -> reverse(binop(x,y))
1652 Plan, [](VPValue *&X) { return m_Reverse(m_VPValue(X)); },
1653 [](auto *X) { return new VPInstruction(VPInstruction::Reverse, X); });
1654
1655 // reverse(reverse(x)) -> x
1656 VPValue *X;
1659 for (VPRecipeBase &R : make_early_inc_range(*VPBB))
1660 if (match(&R, m_Reverse(m_Reverse(m_VPValue(X)))))
1661 R.getVPSingleValue()->replaceAllUsesWith(X);
1662}
1663
1664/// Reassociate (headermask && x) && y -> headermask && (x && y) to allow the
1665/// header mask to be simplified further when tail folding, e.g. in
1666/// optimizeEVLMasks.
1667static void reassociateHeaderMask(VPlan &Plan) {
1668 VPValue *HeaderMask = Plan.getVectorLoopRegion()->getHeaderMask();
1669 if (!HeaderMask)
1670 return;
1671
1672 SmallVector<VPUser *> Worklist;
1673 for (VPUser *U : HeaderMask->users())
1674 if (match(U, m_LogicalAnd(m_Specific(HeaderMask), m_VPValue())))
1676
1677 while (!Worklist.empty()) {
1678 auto *R = dyn_cast<VPSingleDefRecipe>(Worklist.pop_back_val());
1679 VPValue *X, *Y;
1680 if (!R || !match(R, m_LogicalAnd(
1681 m_LogicalAnd(m_Specific(HeaderMask), m_VPValue(X)),
1682 m_VPValue(Y))))
1683 continue;
1684 append_range(Worklist, R->users());
1685 VPBuilder Builder(R);
1686 R->replaceAllUsesWith(
1687 Builder.createLogicalAnd(HeaderMask, Builder.createLogicalAnd(X, Y)));
1688 }
1689}
1690
1691static std::optional<Instruction::BinaryOps>
1693 switch (ID) {
1694 case Intrinsic::masked_udiv:
1695 return Instruction::UDiv;
1696 case Intrinsic::masked_sdiv:
1697 return Instruction::SDiv;
1698 case Intrinsic::masked_urem:
1699 return Instruction::URem;
1700 case Intrinsic::masked_srem:
1701 return Instruction::SRem;
1702 default:
1703 return {};
1704 }
1705}
1706
1708 if (Plan.hasScalarVFOnly())
1709 return;
1710
1712 vp_depth_first_deep(Plan.getEntry()))) {
1713 for (VPRecipeBase &R : make_early_inc_range(reverse(*VPBB))) {
1716 continue;
1717 auto *RepR = dyn_cast<VPReplicateRecipe>(&R);
1718 if (RepR && (RepR->isSingleScalar() || RepR->isPredicated()))
1719 continue;
1720
1721 auto *RepOrWidenR = cast<VPRecipeWithIRFlags>(&R);
1722 if (RepR && RepR->getOpcode() == Instruction::Store &&
1723 vputils::isSingleScalar(RepR->getOperand(1))) {
1724 auto *Clone = new VPReplicateRecipe(
1725 RepOrWidenR->getUnderlyingInstr(), RepOrWidenR->operands(),
1726 true /*IsSingleScalar*/, nullptr /*Mask*/, *RepR /*Flags*/,
1727 *RepR /*Metadata*/, RepR->getDebugLoc());
1728 Clone->insertBefore(RepOrWidenR);
1729 VPBuilder Builder(Clone);
1730 VPValue *ExtractOp = Clone->getOperand(0);
1731 if (vputils::isUniformAcrossVFsAndUFs(RepR->getOperand(1)))
1732 ExtractOp =
1733 Builder.createNaryOp(VPInstruction::ExtractLastPart, ExtractOp);
1734 ExtractOp =
1735 Builder.createNaryOp(VPInstruction::ExtractLastLane, ExtractOp);
1736 Clone->setOperand(0, ExtractOp);
1737 RepR->eraseFromParent();
1738 continue;
1739 }
1740
1741 // Narrow llvm.masked.{u,s}{div,rem} intrinsics with a safe divisor.
1742 if (auto *IntrR = dyn_cast<VPWidenIntrinsicRecipe>(RepOrWidenR)) {
1743 if (!vputils::onlyFirstLaneUsed(IntrR))
1744 continue;
1745 auto Opc = getUnmaskedDivRemOpcode(IntrR->getVectorIntrinsicID());
1746 if (!Opc)
1747 continue;
1748 VPBuilder Builder(IntrR);
1749 VPValue *SafeDivisor = Builder.createSelect(
1750 IntrR->getOperand(2), IntrR->getOperand(1),
1751 Plan.getConstantInt(IntrR->getScalarType(), 1));
1752 VPValue *Clone = Builder.createNaryOp(
1753 *Opc, {IntrR->getOperand(0), SafeDivisor},
1754 VPIRFlags::getDefaultFlags(*Opc), IntrR->getDebugLoc());
1755 IntrR->replaceAllUsesWith(Clone);
1756 IntrR->eraseFromParent();
1757 continue;
1758 }
1759
1760 // Skip recipes that aren't single scalars.
1761 if (!vputils::isSingleScalar(RepOrWidenR))
1762 continue;
1763
1764 // Predicate to check if a user of Op introduces extra broadcasts.
1765 auto IntroducesBCastOf = [](const VPValue *Op) {
1766 return [Op](const VPUser *U) {
1767 if (auto *VPI = dyn_cast<VPInstruction>(U)) {
1771 VPI->getOpcode()))
1772 return false;
1773 }
1774 return !U->usesScalars(Op);
1775 };
1776 };
1777
1778 if (any_of(RepOrWidenR->users(), IntroducesBCastOf(RepOrWidenR)) &&
1779 none_of(RepOrWidenR->operands(), [&](VPValue *Op) {
1780 if (any_of(
1781 make_filter_range(Op->users(), not_equal_to(RepOrWidenR)),
1782 IntroducesBCastOf(Op)))
1783 return false;
1784 // Non-constant live-ins require broadcasts, while constants do not
1785 // need explicit broadcasts.
1786 bool LiveInNeedsBroadcast =
1787 isa<VPIRValue>(Op) && !isa<VPConstant>(Op);
1788 auto *OpR = dyn_cast<VPReplicateRecipe>(Op);
1789 return LiveInNeedsBroadcast || (OpR && OpR->isSingleScalar());
1790 }))
1791 continue;
1792
1793 auto *Clone = VPBuilder::createSingleScalarOp(
1794 vputils::getOpcode(RepOrWidenR), RepOrWidenR->operands(),
1795 /*Mask=*/nullptr, *RepOrWidenR, {}, DebugLoc::getUnknown(),
1796 RepOrWidenR->getUnderlyingInstr());
1797 Clone->insertBefore(RepOrWidenR);
1798 RepOrWidenR->replaceAllUsesWith(Clone);
1799 if (vputils::isDeadRecipe(*RepOrWidenR))
1800 RepOrWidenR->eraseFromParent();
1801 }
1802 }
1803}
1804
1805/// Try to see if all of \p Blend's masks share a common value logically and'ed
1806/// and remove it from the masks.
1808 if (Blend->isNormalized())
1809 return;
1810 VPValue *CommonEdgeMask;
1811 if (!match(Blend->getMask(0),
1812 m_LogicalAnd(m_VPValue(CommonEdgeMask), m_VPValue())))
1813 return;
1814 for (unsigned I = 0; I < Blend->getNumIncomingValues(); I++)
1815 if (!match(Blend->getMask(I),
1816 m_LogicalAnd(m_Specific(CommonEdgeMask), m_VPValue())))
1817 return;
1818 for (unsigned I = 0; I < Blend->getNumIncomingValues(); I++)
1819 Blend->setMask(I, Blend->getMask(I)->getDefiningRecipe()->getOperand(1));
1820}
1821
1822/// Normalize and simplify VPBlendRecipes. Should be run after simplifyRecipes
1823/// to make sure the masks are simplified.
1824static void simplifyBlends(VPlan &Plan) {
1827 for (VPRecipeBase &R : make_early_inc_range(*VPBB)) {
1828 auto *Blend = dyn_cast<VPBlendRecipe>(&R);
1829 if (!Blend)
1830 continue;
1831
1832 removeCommonBlendMask(Blend);
1833
1834 // Try to remove redundant blend recipes.
1835 SmallPtrSet<VPValue *, 4> UniqueValues;
1836 if (Blend->isNormalized() || !match(Blend->getMask(0), m_False()))
1837 UniqueValues.insert(Blend->getIncomingValue(0));
1838 for (unsigned I = 1; I != Blend->getNumIncomingValues(); ++I)
1839 if (!match(Blend->getMask(I), m_False()))
1840 UniqueValues.insert(Blend->getIncomingValue(I));
1841
1842 if (UniqueValues.size() == 1) {
1843 Blend->replaceAllUsesWith(*UniqueValues.begin());
1844 Blend->eraseFromParent();
1845 continue;
1846 }
1847
1848 if (Blend->isNormalized())
1849 continue;
1850
1851 // Normalize the blend so its first incoming value is used as the initial
1852 // value with the others blended into it.
1853
1854 unsigned StartIndex = 0;
1855 for (unsigned I = 0; I != Blend->getNumIncomingValues(); ++I) {
1856 // If a value's mask is used only by the blend then is can be deadcoded.
1857 // TODO: Find the most expensive mask that can be deadcoded, or a mask
1858 // that's used by multiple blends where it can be removed from them all.
1859 VPValue *Mask = Blend->getMask(I);
1860 if (Mask->hasOneUse() && !match(Mask, m_False())) {
1861 StartIndex = I;
1862 break;
1863 }
1864 }
1865
1866 SmallVector<VPValue *, 4> OperandsWithMask;
1867 OperandsWithMask.push_back(Blend->getIncomingValue(StartIndex));
1868
1869 for (unsigned I = 0; I != Blend->getNumIncomingValues(); ++I) {
1870 if (I == StartIndex)
1871 continue;
1872 OperandsWithMask.push_back(Blend->getIncomingValue(I));
1873 OperandsWithMask.push_back(Blend->getMask(I));
1874 }
1875
1876 auto *NewBlend =
1877 new VPBlendRecipe(cast_or_null<PHINode>(Blend->getUnderlyingValue()),
1878 OperandsWithMask, *Blend, Blend->getDebugLoc());
1879 NewBlend->insertBefore(&R);
1880
1881 VPValue *DeadMask = Blend->getMask(StartIndex);
1882 Blend->replaceAllUsesWith(NewBlend);
1883 Blend->eraseFromParent();
1885
1886 /// Simplify BLEND %a, %b, Not(%mask) -> BLEND %b, %a, %mask.
1887 VPValue *NewMask;
1888 if (NewBlend->getNumOperands() == 3 &&
1889 match(NewBlend->getMask(1), m_Not(m_VPValue(NewMask)))) {
1890 VPValue *Inc0 = NewBlend->getOperand(0);
1891 VPValue *Inc1 = NewBlend->getOperand(1);
1892 VPValue *OldMask = NewBlend->getOperand(2);
1893 NewBlend->setOperand(0, Inc1);
1894 NewBlend->setOperand(1, Inc0);
1895 NewBlend->setOperand(2, NewMask);
1896 if (OldMask->user_empty())
1897 cast<VPInstruction>(OldMask)->eraseFromParent();
1898 }
1899 }
1900 }
1901}
1902
1903/// Optimize the width of vector induction variables in \p Plan based on a known
1904/// constant Trip Count, \p BestVF and \p BestUF.
1906 ElementCount BestVF,
1907 unsigned BestUF) {
1908 // Only proceed if we have not completely removed the vector region.
1909 if (!Plan.getVectorLoopRegion())
1910 return false;
1911
1912 const APInt *TC;
1913 if (!BestVF.isFixed() || !match(Plan.getTripCount(), m_APInt(TC)))
1914 return false;
1915
1916 // Calculate the minimum power-of-2 bit width that can fit the known TC, VF
1917 // and UF. Returns at least 8.
1918 auto ComputeBitWidth = [](APInt TC, uint64_t Align) {
1919 APInt AlignedTC =
1922 APInt MaxVal = AlignedTC - 1;
1923 return std::max<unsigned>(PowerOf2Ceil(MaxVal.getActiveBits()), 8);
1924 };
1925 unsigned NewBitWidth =
1926 ComputeBitWidth(*TC, BestVF.getKnownMinValue() * BestUF);
1927
1928 LLVMContext &Ctx = Plan.getContext();
1929 auto *NewIVTy = IntegerType::get(Ctx, NewBitWidth);
1930
1931 bool MadeChange = false;
1932
1933 VPBasicBlock *HeaderVPBB = Plan.getVectorLoopRegion()->getEntryBasicBlock();
1934 for (VPRecipeBase &Phi : HeaderVPBB->phis()) {
1935 // Currently only handle canonical IVs as it is trivial to replace the start
1936 // and stop values, and we currently only perform the optimization when the
1937 // IV has a single use.
1939 if (!match(&Phi, m_CanonicalWidenIV(WideIV)))
1940 continue;
1941 if (WideIV->hasMoreThanOneUniqueUser() ||
1942 NewIVTy == WideIV->getScalarType())
1943 continue;
1944
1945 // Currently only handle cases where the single user is a header-mask
1946 // comparison with the backedge-taken-count.
1947 VPUser *SingleUser = WideIV->getSingleUser();
1948 if (!SingleUser ||
1949 !match(SingleUser,
1950 m_ICmp(m_Specific(WideIV),
1952 continue;
1953
1954 // Update IV operands and comparison bound to use new narrower type.
1955 assert(!WideIV->getTruncInst() &&
1956 "canonical IV is not expected to have a truncation");
1957 auto *NewWideIV = new VPWidenIntOrFpInductionRecipe(
1958 WideIV->getPHINode(), Plan.getZero(NewIVTy),
1959 Plan.getConstantInt(NewIVTy, 1), WideIV->getVFValue(),
1960 WideIV->getInductionDescriptor(), *WideIV, WideIV->getDebugLoc());
1961 NewWideIV->insertBefore(WideIV);
1962
1963 auto *NewBTC = new VPWidenCastRecipe(
1964 Instruction::Trunc, Plan.getOrCreateBackedgeTakenCount(), NewIVTy,
1965 nullptr, VPIRFlags::getDefaultFlags(Instruction::Trunc));
1966 Plan.getVectorPreheader()->appendRecipe(NewBTC);
1967 auto *Cmp = cast<VPInstruction>(WideIV->getSingleUser());
1968 Cmp->replaceAllUsesWith(
1969 VPBuilder(Cmp).createICmp(Cmp->getPredicate(), NewWideIV, NewBTC));
1970
1971 MadeChange = true;
1972 }
1973
1974 return MadeChange;
1975}
1976
1977/// Return true if \p Cond is known to be true for given \p BestVF and \p
1978/// BestUF.
1980 ElementCount BestVF, unsigned BestUF,
1983 return any_of(Cond->getDefiningRecipe()->operands(), [&Plan, BestVF, BestUF,
1984 &PSE](VPValue *C) {
1985 return isConditionTrueViaVFAndUF(C, Plan, BestVF, BestUF, PSE);
1986 });
1987
1988 auto *CanIV = Plan.getVectorLoopRegion()->getCanonicalIV();
1991 m_c_Add(m_Specific(CanIV), m_Specific(&Plan.getVFxUF())),
1992 m_Specific(&Plan.getVectorTripCount()))))
1993 return false;
1994
1995 // The compare checks CanIV + VFxUF == vector trip count. The vector trip
1996 // count is not conveniently available as SCEV so far, so we compare directly
1997 // against the original trip count. This is stricter than necessary, as we
1998 // will only return true if the trip count == vector trip count.
1999 const SCEV *VectorTripCount =
2001 if (isa<SCEVCouldNotCompute>(VectorTripCount))
2002 VectorTripCount = vputils::getSCEVExprForVPValue(Plan.getTripCount(), PSE);
2003 assert(!isa<SCEVCouldNotCompute>(VectorTripCount) &&
2004 "Trip count SCEV must be computable");
2005 ScalarEvolution &SE = *PSE.getSE();
2006 ElementCount NumElements = BestVF.multiplyCoefficientBy(BestUF);
2007 const SCEV *C = SE.getElementCount(VectorTripCount->getType(), NumElements);
2008 return SE.isKnownPredicate(CmpInst::ICMP_EQ, VectorTripCount, C);
2009}
2010
2011// Replaces ExtractVectorForPart instructions with ICMP when the VF is scalar
2012// and the source is a WideActiveLaneMask. The unused mask is removed later
2013// when removing dead recipes.
2015 ElementCount BestVF) {
2016 if (!BestVF.isScalar())
2017 return false;
2018
2019 bool MadeChange = false;
2020 VPBuilder Builder;
2021 VPRegionBlock *VectorRegion = Plan.getVectorLoopRegion();
2022 VPBasicBlock *PreheaderVPBB = Plan.getVectorPreheader();
2023 VPBasicBlock *ExitingVPBB = VectorRegion->getExitingBasicBlock();
2024
2025 VPValue *Start, *TC;
2026 uint64_t Idx;
2027 for (VPBasicBlock *VPBB : {PreheaderVPBB, ExitingVPBB}) {
2028 for (VPRecipeBase &R : make_early_inc_range(*VPBB)) {
2031 m_VPValue()),
2032 m_ConstantInt(Idx))))
2033 continue;
2034
2035 auto *Extract = cast<VPInstruction>(&R);
2036 Builder.setInsertPoint(Extract);
2037
2038 if (Idx > 0)
2039 Start = Builder.createAdd(
2040 Start, Plan.getConstantInt(Start->getScalarType(), Idx));
2041
2042 VPValue *ICmp = Builder.createICmp(CmpInst::ICMP_ULT, Start, TC);
2043 Extract->replaceAllUsesWith(ICmp);
2044 Extract->eraseFromParent();
2045 MadeChange = true;
2046 }
2047 }
2048
2049 return MadeChange;
2050}
2051
2052/// Try to simplify the branch condition of \p Plan. This may restrict the
2053/// resulting plan to \p BestVF and \p BestUF.
2055 unsigned BestUF,
2057 VPRegionBlock *VectorRegion = Plan.getVectorLoopRegion();
2058 VPBasicBlock *ExitingVPBB = VectorRegion->getExitingBasicBlock();
2059 auto *Term = &ExitingVPBB->back();
2060 VPValue *Cond;
2061 auto m_CanIVInc = m_Add(m_VPValue(), m_Specific(&Plan.getVFxUF()));
2062 // Check if the branch condition compares the canonical IV increment (for main
2063 // loop), or the canonical IV increment plus an offset (for epilog loop).
2064 if (match(Term, m_BranchOnCount(
2065 m_CombineOr(m_CanIVInc, m_c_Add(m_CanIVInc, m_LiveIn())),
2066 m_VPValue())) ||
2067 match(Term,
2070 m_ZeroInt()))))) {
2071 // Try to simplify the branch condition if VectorTC <= VF * UF when the
2072 // latch terminator is BranchOnCount or
2073 // BranchOnCond(Not(ExtractVectorForPart(WideActiveLaneMask), 0))
2074 const SCEV *VectorTripCount =
2076 if (isa<SCEVCouldNotCompute>(VectorTripCount))
2077 VectorTripCount =
2079 assert(!isa<SCEVCouldNotCompute>(VectorTripCount) &&
2080 "Trip count SCEV must be computable");
2081 ScalarEvolution &SE = *PSE.getSE();
2082 ElementCount NumElements = BestVF.multiplyCoefficientBy(BestUF);
2083 const SCEV *C = SE.getElementCount(VectorTripCount->getType(), NumElements);
2084 if (!SE.isKnownPredicate(CmpInst::ICMP_ULE, VectorTripCount, C))
2085 return false;
2086 } else if (match(Term, m_BranchOnCond(m_VPValue(Cond))) ||
2088 // For BranchOnCond, check if we can prove the condition to be true using VF
2089 // and UF.
2090 if (!isConditionTrueViaVFAndUF(Cond, Plan, BestVF, BestUF, PSE))
2091 return false;
2092 } else {
2093 return false;
2094 }
2095
2096 // The vector loop region only executes once. Convert terminator of the
2097 // exiting block to exit in the first iteration.
2098 if (match(Term, m_BranchOnTwoConds())) {
2099 Term->setOperand(1, Plan.getTrue());
2100 return true;
2101 }
2102
2103 auto *BOC = new VPInstruction(VPInstruction::BranchOnCond, Plan.getTrue(), {},
2104 {}, Term->getDebugLoc());
2105 ExitingVPBB->appendRecipe(BOC);
2106 Term->eraseFromParent();
2107
2108 return true;
2109}
2110
2112 unsigned BestUF,
2114 assert(Plan.hasVF(BestVF) && "BestVF is not available in Plan");
2115 assert(Plan.hasUF(BestUF) && "BestUF is not available in Plan");
2116
2117 bool MadeChange =
2118 simplifyBranchConditionForVFAndUF(Plan, BestVF, BestUF, PSE);
2119 MadeChange |= replaceMaskWithCompareForScalarPlan(Plan, BestVF);
2120 MadeChange |= optimizeVectorInductionWidthForTCAndVFUF(Plan, BestVF, BestUF);
2121
2122 if (MadeChange) {
2123 Plan.setVF(BestVF);
2124 assert(Plan.getConcreteUF() == BestUF && "BestUF must match the Plan's UF");
2125 }
2126}
2127
2129 for (VPRecipeBase &R :
2131 auto *PhiR = dyn_cast<VPReductionPHIRecipe>(&R);
2132 if (!PhiR)
2133 continue;
2134 RecurKind RK = PhiR->getRecurrenceKind();
2135 if (RK != RecurKind::Add && RK != RecurKind::Mul && RK != RecurKind::Sub &&
2137 continue;
2138
2140 if (auto *RecWithFlags = dyn_cast<VPRecipeWithIRFlags>(U)) {
2141 RecWithFlags->dropPoisonGeneratingFlags();
2142 }
2143 }
2144}
2145
2146namespace {
2147struct VPCSEDenseMapInfo : public DenseMapInfo<VPSingleDefRecipe *> {
2148 /// If recipe \p R will lower to a GEP with a non-i8 source element type,
2149 /// return that source element type.
2150 static Type *getGEPSourceElementType(const VPSingleDefRecipe *R) {
2151 // All VPInstructions that lower to GEPs must have the i8 source element
2152 // type (as they are PtrAdds), so we omit it.
2154 .Case([](const VPReplicateRecipe *I) -> Type * {
2155 if (auto *GEP = dyn_cast<GetElementPtrInst>(I->getUnderlyingValue()))
2156 return GEP->getSourceElementType();
2157 return nullptr;
2158 })
2159 .Case<VPVectorPointerRecipe, VPWidenGEPRecipe>(
2160 [](auto *I) { return I->getSourceElementType(); })
2161 .Default([](auto *) { return nullptr; });
2162 }
2163
2164 /// Returns true if recipe \p Def can be safely handed for CSE.
2165 static bool canHandle(const VPSingleDefRecipe *Def) {
2166 // We can extend the list of handled recipes in the future,
2167 // provided we account for the data embedded in them while checking for
2168 // equality or hashing.
2170
2171 // The issue with (Insert|Extract)Value is that the index of the
2172 // insert/extract is not a proper operand in LLVM IR, and hence also not in
2173 // VPlan.
2174 if (!C || (!C->first && (C->second == Instruction::InsertValue ||
2175 C->second == Instruction::ExtractValue)))
2176 return false;
2177
2178 // During CSE, we can only handle non-memory recipes, as memory can alias.
2179 return !Def->mayReadOrWriteMemory();
2180 }
2181
2182 /// Hash the underlying data of \p Def.
2183 static unsigned getHashValue(const VPSingleDefRecipe *Def) {
2184 hash_code Result = hash_combine(
2185 Def->getVPRecipeID(), vputils::getOpcodeOrIntrinsicID(Def),
2186 getGEPSourceElementType(Def), Def->getScalarType(),
2188 if (auto *RFlags = dyn_cast<VPRecipeWithIRFlags>(Def))
2189 if (RFlags->hasPredicate())
2190 return hash_combine(Result, RFlags->getPredicate());
2191 if (auto *SIVSteps = dyn_cast<VPScalarIVStepsRecipe>(Def))
2192 return hash_combine(Result, SIVSteps->getInductionOpcode());
2193 return Result;
2194 }
2195
2196 /// Check equality of underlying data of \p L and \p R.
2197 static bool isEqual(const VPSingleDefRecipe *L, const VPSingleDefRecipe *R) {
2198 if (L->getVPRecipeID() != R->getVPRecipeID() ||
2201 getGEPSourceElementType(L) != getGEPSourceElementType(R) ||
2203 !equal(L->operands(), R->operands()))
2204 return false;
2207 "must have valid opcode info for both recipes");
2208 if (auto *LFlags = dyn_cast<VPRecipeWithIRFlags>(L))
2209 if (LFlags->hasPredicate() &&
2210 LFlags->getPredicate() !=
2211 cast<VPRecipeWithIRFlags>(R)->getPredicate())
2212 return false;
2213 if (auto *LSIV = dyn_cast<VPScalarIVStepsRecipe>(L))
2214 if (LSIV->getInductionOpcode() !=
2215 cast<VPScalarIVStepsRecipe>(R)->getInductionOpcode())
2216 return false;
2217 // Phi recipes can only be equal if they are in the same VPBB, as they
2218 // implicitly depend on their predecessors.
2219 if (isa<VPWidenPHIRecipe>(L) && L->getParent() != R->getParent())
2220 return false;
2221 // Recipes in replicate regions implicitly depend on predicate. If either
2222 // recipe is in a replicate region, only consider them equal if both have
2223 // the same parent.
2224 const VPRegionBlock *RegionL = L->getRegion();
2225 const VPRegionBlock *RegionR = R->getRegion();
2226 if (((RegionL && RegionL->isReplicator()) ||
2227 (RegionR && RegionR->isReplicator())) &&
2228 L->getParent() != R->getParent())
2229 return false;
2230 return L->getScalarType() == R->getScalarType();
2231 }
2232};
2233} // end anonymous namespace
2234
2235/// Perform a common-subexpression-elimination of VPSingleDefRecipes on the \p
2236/// Plan.
2238 VPDominatorTree VPDT(Plan);
2240
2242 Plan.getEntry());
2244 for (VPRecipeBase &R : *VPBB) {
2245 auto *Def = dyn_cast<VPSingleDefRecipe>(&R);
2246 if (!Def || !VPCSEDenseMapInfo::canHandle(Def))
2247 continue;
2248 if (VPSingleDefRecipe *V = CSEMap.lookup(Def)) {
2249 // V must dominate Def for a valid replacement.
2250 if (!VPDT.dominates(V->getParent(), VPBB))
2251 continue;
2252 // Only keep flags present on both V and Def.
2253 if (auto *RFlags = dyn_cast<VPRecipeWithIRFlags>(V))
2254 RFlags->intersectFlags(*cast<VPRecipeWithIRFlags>(Def));
2255 Def->replaceAllUsesWith(V);
2256 continue;
2257 }
2258 CSEMap[Def] = Def;
2259 }
2260 }
2261}
2262
2263/// Return true if we do not know how to (mechanically) hoist or sink a
2264/// non-memory or memory recipe \p R out of a loop region. When sinking, passing
2265/// \p Sinking = true ensures that assumes aren't sunk.
2267 VPBasicBlock *LastBB,
2268 bool Sinking = false) {
2269 if (!isa<VPReplicateRecipe>(R) || !R.mayReadOrWriteMemory() ||
2271 return vputils::cannotHoistOrSinkRecipe(R, Sinking);
2272
2273 // Check that the memory operation doesn't alias between FirstBB and LastBB.
2274 auto MemLoc = vputils::getMemoryLocation(R);
2275
2276 // TODO: Could make use of SinkStoreInfo::isNoAliasViaDistance by collecting
2277 // stores upfront, and constructing a full SinkStoreInfo.
2278 auto SinkInfo =
2279 Sinking ? std::make_optional(SinkStoreInfo(cast<VPReplicateRecipe>(R)))
2280 : std::nullopt;
2281
2282 return !MemLoc ||
2283 !canHoistOrSinkWithNoAliasCheck(*MemLoc, FirstBB, LastBB, SinkInfo);
2284}
2285
2286/// Move loop-invariant recipes out of the vector loop region in \p Plan.
2287static void licm(VPlan &Plan) {
2288 VPBasicBlock *Preheader = Plan.getVectorPreheader();
2289
2290 // Hoist any loop invariant recipes from the vector loop region to the
2291 // preheader. Preform a shallow traversal of the vector loop region, to
2292 // exclude recipes in replicate regions. Since the top-level blocks in the
2293 // vector loop region are guaranteed to execute if the vector pre-header is,
2294 // we don't need to check speculation safety.
2295 VPRegionBlock *LoopRegion = Plan.getVectorLoopRegion();
2296 assert(Preheader->getSingleSuccessor() == LoopRegion &&
2297 "Expected vector prehader's successor to be the vector loop region");
2299 vp_depth_first_shallow(LoopRegion->getEntry()))) {
2300 for (VPRecipeBase &R : make_early_inc_range(*VPBB)) {
2301 if (cannotHoistOrSinkRecipe(R, LoopRegion->getEntryBasicBlock(),
2302 LoopRegion->getExitingBasicBlock()))
2303 continue;
2304 if (any_of(R.operands(), [](VPValue *Op) {
2305 return !Op->isDefinedOutsideLoopRegions();
2306 }))
2307 continue;
2308 R.moveBefore(*Preheader, Preheader->end());
2309 }
2310 }
2311
2312#ifndef NDEBUG
2313 VPDominatorTree VPDT(Plan);
2314#endif
2315 // Sink recipes with no users inside the vector loop region if all users are
2316 // in the same exit block of the region.
2317 // TODO: Extend to sink recipes from inner loops.
2319 LoopRegion->getEntry());
2321 for (VPRecipeBase &R : make_early_inc_range(reverse(*VPBB))) {
2322 if (cannotHoistOrSinkRecipe(R, LoopRegion->getEntryBasicBlock(),
2323 LoopRegion->getExitingBasicBlock(),
2324 /*Sinking=*/true))
2325 continue;
2326
2327 if (auto *RepR = dyn_cast<VPReplicateRecipe>(&R)) {
2328 assert(!RepR->isPredicated() &&
2329 "Expected prior transformation of predicated replicates to "
2330 "replicate regions");
2331 // narrowToSingleScalarRecipes should have already maximally narrowed
2332 // replicates to single-scalar replicates.
2333 // TODO: When unrolling, replicateByVF doesn't handle sunk
2334 // non-single-scalar replicates correctly.
2335 if (!RepR->isSingleScalar())
2336 continue;
2337
2338 // The pointer operand of stores must be loop-invariant.
2339 if (RepR->getOpcode() == Instruction::Store &&
2340 !RepR->getOperand(1)->isDefinedOutsideLoopRegions())
2341 continue;
2342 }
2343
2344 [[maybe_unused]] auto *RepR = dyn_cast<VPReplicateRecipe>(&R);
2345 assert((!R.mayWriteToMemory() ||
2346 (RepR && RepR->getOpcode() == Instruction::Store &&
2347 RepR->getOperand(1)->isDefinedOutsideLoopRegions())) &&
2348 "The only recipes that may write to memory are expected to be "
2349 "stores with invariant pointer-operand");
2350
2351 // TODO: Use R.definedValues() instead of casting to VPSingleDefRecipe to
2352 // support recipes with multiple defined values (e.g., interleaved loads).
2353 auto *Def = cast<VPSingleDefRecipe>(&R);
2354
2355 // Cannot sink the recipe if the user is defined in a loop region or a
2356 // non-successor of the vector loop region. Cannot sink if user is a phi
2357 // either.
2358 VPBasicBlock *SinkBB = nullptr;
2359 if (any_of(Def->users(), [&SinkBB, &LoopRegion](VPUser *U) {
2360 auto *UserR = cast<VPRecipeBase>(U);
2361 VPBasicBlock *Parent = UserR->getParent();
2362 // TODO: Support sinking when users are in multiple blocks.
2363 if (SinkBB && SinkBB != Parent)
2364 return true;
2365 SinkBB = Parent;
2366 // TODO: If the user is a PHI node, we should check the block of
2367 // incoming value. Support PHI node users if needed.
2368 return UserR->isPhi() || Parent->getEnclosingLoopRegion() ||
2369 Parent->getSinglePredecessor() != LoopRegion;
2370 }))
2371 continue;
2372
2373 if (!SinkBB)
2374 SinkBB = cast<VPBasicBlock>(LoopRegion->getSingleSuccessor());
2375
2376 // TODO: This will need to be a check instead of a assert after
2377 // conditional branches in vectorized loops are supported.
2378 assert(VPDT.properlyDominates(VPBB, SinkBB) &&
2379 "Defining block must dominate sink block");
2380 // TODO: Clone the recipe if users are on multiple exit paths, instead of
2381 // just moving.
2382 Def->moveBefore(*SinkBB, SinkBB->getFirstNonPhi());
2383 }
2384 }
2385}
2386
2388 VPlan &Plan, const MapVector<Instruction *, uint64_t> &MinBWs) {
2389 if (Plan.hasScalarVFOnly())
2390 return;
2391 // Keep track of created truncates, so they can be re-used. Note that we
2392 // cannot use RAUW after creating a new truncate, as this would could make
2393 // other uses have different types for their operands, making them invalidly
2394 // typed.
2396 VPBasicBlock *PH = Plan.getVectorPreheader();
2399 for (VPRecipeBase &R : make_early_inc_range(*VPBB)) {
2402 continue;
2403
2404 VPValue *ResultVPV = R.getVPSingleValue();
2405 auto *UI = cast_or_null<Instruction>(ResultVPV->getUnderlyingValue());
2406 unsigned NewResSizeInBits = MinBWs.lookup(UI);
2407 if (!NewResSizeInBits)
2408 continue;
2409
2410 // If the value wasn't vectorized, we must maintain the original scalar
2411 // type. Skip those here, after incrementing NumProcessedRecipes. Also
2412 // skip casts which do not need to be handled explicitly here, as
2413 // redundant casts will be removed during recipe simplification.
2415 continue;
2416
2417 Type *OldResTy = ResultVPV->getScalarType();
2418 unsigned OldResSizeInBits = OldResTy->getScalarSizeInBits();
2419 assert(OldResTy->isIntegerTy() && "only integer types supported");
2420 (void)OldResSizeInBits;
2421
2422 auto *NewResTy = IntegerType::get(Plan.getContext(), NewResSizeInBits);
2423
2424 // Any wrapping introduced by shrinking this operation shouldn't be
2425 // considered undefined behavior. So, we can't unconditionally copy
2426 // arithmetic wrapping flags to VPW.
2427 if (auto *VPW = dyn_cast<VPRecipeWithIRFlags>(&R))
2428 VPW->dropPoisonGeneratingFlags();
2429
2430 assert((OldResSizeInBits != NewResSizeInBits ||
2431 match(&R, m_ICmp(m_VPValue(), m_VPValue()))) &&
2432 "Only ICmps should not need extending the result.");
2433 assert(!isa<VPWidenStoreRecipe>(&R) && "stores cannot be narrowed");
2434
2435 // For loads/intrinsics we don't recreate the recipe; just wrap the
2436 // original wide result in a ZExt to OldResTy.
2438 if (OldResSizeInBits != NewResSizeInBits) {
2440 Instruction::ZExt, ResultVPV, OldResTy);
2441 ResultVPV->replaceAllUsesWith(Ext);
2442 Ext->setOperand(0, ResultVPV);
2443 }
2444 continue;
2445 }
2446
2447 // Shrink operands by introducing truncates as needed.
2448 unsigned StartIdx =
2449 match(&R, m_Select(m_VPValue(), m_VPValue(), m_VPValue())) ? 1 : 0;
2450 SmallVector<VPValue *> NewOperands(R.operands());
2451 for (VPValue *&Op : drop_begin(NewOperands, StartIdx)) {
2452 unsigned OpSizeInBits = Op->getScalarType()->getScalarSizeInBits();
2453 if (OpSizeInBits == NewResSizeInBits)
2454 continue;
2455 assert(OpSizeInBits > NewResSizeInBits && "nothing to truncate");
2456 auto [ProcessedIter, Inserted] = ProcessedTruncs.try_emplace(Op);
2457 if (Inserted) {
2458 VPBuilder Builder;
2459 if (isa<VPIRValue>(Op))
2460 Builder.setInsertPoint(PH);
2461 else
2462 Builder.setInsertPoint(&R);
2463 ProcessedIter->second =
2464 Builder.createWidenCast(Instruction::Trunc, Op, NewResTy);
2465 }
2466 Op = ProcessedIter->second;
2467 }
2468
2469 auto *NWR = cast<VPWidenRecipe>(&R)->cloneWithOperands(NewOperands);
2470 NWR->insertBefore(&R);
2471
2472 // Wrap NWR in a ZExt to preserve the original wide type for downstream
2473 // users (unless this is an ICmp, which produces i1 regardless).
2474 VPValue *Replacement = NWR->getVPSingleValue();
2475 if (OldResSizeInBits != NewResSizeInBits)
2476 Replacement =
2478 .createWidenCast(Instruction::ZExt, Replacement, OldResTy)
2479 ->getVPSingleValue();
2480 ResultVPV->replaceAllUsesWith(Replacement);
2481 R.eraseFromParent();
2482 }
2483 }
2484}
2485
2486bool VPlanTransforms::removeBranchOnConst(VPlan &Plan, bool OnlyLatches) {
2487 std::optional<VPDominatorTree> VPDT;
2488 if (OnlyLatches)
2489 VPDT.emplace(Plan);
2490
2491 // Collect all blocks before modifying the CFG so we can identify unreachable
2492 // ones after constant branch removal.
2494
2495 bool SimplifiedPhi = false;
2496 for (VPBasicBlock *VPBB : VPBlockUtils::blocksOnly<VPBasicBlock>(AllBlocks)) {
2497 VPValue *Cond;
2498 // Skip blocks that are not terminated by BranchOnCond.
2499 if (VPBB->empty() || !match(&VPBB->back(), m_BranchOnCond(m_VPValue(Cond))))
2500 continue;
2501
2502 if (OnlyLatches && !VPBlockUtils::isLatch(VPBB, *VPDT))
2503 continue;
2504
2505 assert(VPBB->getNumSuccessors() == 2 &&
2506 "Two successors expected for BranchOnCond");
2507 unsigned RemovedIdx;
2508 if (match(Cond, m_True()))
2509 RemovedIdx = 1;
2510 else if (match(Cond, m_False()))
2511 RemovedIdx = 0;
2512 else
2513 continue;
2514
2515 VPBasicBlock *RemovedSucc =
2516 cast<VPBasicBlock>(VPBB->getSuccessors()[RemovedIdx]);
2517 assert(count(RemovedSucc->getPredecessors(), VPBB) == 1 &&
2518 "There must be a single edge between VPBB and its successor");
2519 // Values coming from VPBB into phi recipes of RemovedSucc are removed from
2520 // these recipes and single-entry header phis are removed.
2521 for (VPRecipeBase &R : make_early_inc_range(RemovedSucc->phis())) {
2522 cast<VPPhiAccessors>(&R)->removeIncomingValueFor(VPBB);
2523 SimplifiedPhi = true;
2524 // Remove now invalid header phis that are left single-entry after
2525 // removing their backedges.
2526 auto *PhiR = dyn_cast<VPHeaderPHIRecipe>(&R);
2527 if (!PhiR || PhiR->getNumIncoming() != 1)
2528 continue;
2529 PhiR->replaceAllUsesWith(PhiR->getOperand(0));
2530 PhiR->eraseFromParent();
2531 }
2532
2533 // Disconnect blocks and remove the terminator.
2534 VPBlockUtils::disconnectBlocks(VPBB, RemovedSucc);
2535 VPBB->back().eraseFromParent();
2536 }
2537
2538 // Compute which blocks are still reachable from the entry after constant
2539 // branch removal.
2542
2543 // Detach all unreachable blocks from their successors, removing their recipes
2544 // and incoming values from phi recipes.
2545 VPSymbolicValue Tmp(nullptr);
2546 for (VPBlockBase *B : AllBlocks) {
2547 if (Reachable.contains(B))
2548 continue;
2549 for (VPBlockBase *Succ : to_vector(B->successors())) {
2550 if (auto *SuccBB = dyn_cast<VPBasicBlock>(Succ))
2551 for (VPRecipeBase &R : SuccBB->phis())
2552 cast<VPPhiAccessors>(&R)->removeIncomingValueFor(B);
2554 }
2555 for (VPBasicBlock *DeadBB :
2557 for (VPRecipeBase &R : make_early_inc_range(*DeadBB)) {
2558 for (VPValue *Def : R.definedValues())
2559 Def->replaceAllUsesWith(&Tmp);
2560 R.eraseFromParent();
2561 }
2562 }
2563 }
2564 return SimplifiedPhi;
2565}
2566
2587
2590 auto GetSimplifiedLiveInViaSCEV = [&](VPValue *VPV) -> VPValue * {
2591 const SCEV *Expr = vputils::getSCEVExprForVPValue(VPV, PSE);
2592 const APInt *C;
2593 if (match(Expr, m_scev_APInt(C)))
2594 return Plan.getConstantInt(*C);
2595 return nullptr;
2596 };
2597
2598 for (VPValue *LiveIn : to_vector(Plan.getLiveIns())) {
2599 if (VPValue *SimplifiedLiveIn = GetSimplifiedLiveInViaSCEV(LiveIn))
2600 LiveIn->replaceAllUsesWith(SimplifiedLiveIn);
2601 }
2602}
2603
2605 VPlan &Plan, PredicatedScalarEvolution &PSE,
2606 const DenseMap<Value *, const SCEV *> &StridesMap,
2607 const VPDominatorTree &VPDT) {
2608 // Replace VPValues for known constant strides guaranteed by predicated scalar
2609 // evolution that are guaranteed to be guarded by the runtime checks; that is,
2610 // blocks dominated by the vector header.
2611 assert(!Plan.getVectorLoopRegion() &&
2612 "expected to run before loop regions are created");
2613 const auto &[Header, _] = VPBlockUtils::getPlainCFGHeaderAndLatch(Plan);
2614 auto CanUseVersionedStride = [&VPDT, Header = Header, &Plan](VPUser &U,
2615 unsigned Idx) {
2616 auto *R = cast<VPRecipeBase>(&U);
2617 // Skip phis if the loop if loop is not yet guarded.
2618 if (isa<VPPhiAccessors>(R) &&
2619 Header == Plan.getEntry()->getSingleSuccessor())
2620 return false;
2621 return VPDT.dominates(Header, R->getParent());
2622 };
2623 ValueToSCEVMapTy RewriteMap;
2624 for (const SCEV *Stride : StridesMap.values()) {
2625 Value *StrideV = cast<SCEVUnknown>(Stride)->getValue();
2626 const APInt *StrideConst;
2627 const SCEV *StrideExpr = PSE.getSCEV(StrideV);
2628 if (!match(StrideExpr, m_scev_APInt(StrideConst)))
2629 // Only handle constant strides for now.
2630 continue;
2631 if (VPValue *StrideVPV = Plan.getLiveIn(StrideV))
2632 StrideVPV->replaceUsesWithIf(Plan.getConstantInt(*StrideConst),
2633 CanUseVersionedStride);
2634
2635 // The versioned value may not be used in the loop directly but through an
2636 // integral cast (sext/zext/trunc). Add new live-ins in those cases.
2637 for (Value *U : StrideV->users()) {
2639 continue;
2640 VPValue *StrideVPV = Plan.getLiveIn(U);
2641 if (!StrideVPV)
2642 continue;
2643 unsigned BW = U->getType()->getScalarSizeInBits();
2644 APInt C = isa<SExtInst>(U) ? StrideConst->sext(BW)
2645 : StrideConst->zextOrTrunc(BW);
2646 StrideVPV->replaceUsesWithIf(Plan.getConstantInt(C),
2647 CanUseVersionedStride);
2648 }
2649 RewriteMap[StrideV] = StrideExpr;
2650 }
2651
2652 for (VPRecipeBase &R : *Plan.getEntry()) {
2653 auto *ExpSCEV = dyn_cast<VPExpandSCEVRecipe>(&R);
2654 if (!ExpSCEV)
2655 continue;
2656 const SCEV *ScevExpr = ExpSCEV->getSCEV();
2657 auto *NewSCEV =
2658 SCEVParameterRewriter::rewrite(ScevExpr, *PSE.getSE(), RewriteMap);
2659 if (NewSCEV != ScevExpr) {
2660 VPValue *NewExp = vputils::getOrCreateVPValueForSCEVExpr(Plan, NewSCEV);
2661 ExpSCEV->replaceAllUsesWith(NewExp);
2662 if (Plan.getTripCount() == ExpSCEV)
2663 Plan.resetTripCount(NewExp);
2664 }
2665 }
2666}
2667
2669 // Collect recipes in the backward slice of `Root` that may generate a poison
2670 // value that is used after vectorization.
2672 auto CollectPoisonGeneratingInstrsInBackwardSlice([&](VPRecipeBase *Root) {
2674 Worklist.push_back(Root);
2675
2676 // Traverse the backward slice of Root through its use-def chain.
2677 while (!Worklist.empty()) {
2678 VPRecipeBase *CurRec = Worklist.pop_back_val();
2679
2680 if (!Visited.insert(CurRec).second)
2681 continue;
2682
2683 // Prune search if we find another recipe generating a widen memory
2684 // instruction. Widen memory instructions involved in address computation
2685 // will lead to gather/scatter instructions, which don't need to be
2686 // handled.
2688 VPHeaderPHIRecipe>(CurRec))
2689 continue;
2690
2691 // This recipe contributes to the address computation of a widen
2692 // load/store. If the underlying instruction has poison-generating flags,
2693 // drop them directly.
2694 if (auto *RecWithFlags = dyn_cast<VPRecipeWithIRFlags>(CurRec)) {
2695 VPValue *A, *B;
2696 // Dropping disjoint from an OR may yield incorrect results, as some
2697 // analysis may have converted it to an Add implicitly (e.g. SCEV used
2698 // for dependence analysis). Instead, replace it with an equivalent Add.
2699 // This is possible as all users of the disjoint OR only access lanes
2700 // where the operands are disjoint or poison otherwise.
2701 if (match(RecWithFlags, m_BinaryOr(m_VPValue(A), m_VPValue(B))) &&
2702 RecWithFlags->isDisjoint()) {
2703 VPBuilder Builder(RecWithFlags);
2704 VPInstruction *New =
2705 Builder.createAdd(A, B, RecWithFlags->getDebugLoc());
2706 New->setUnderlyingValue(RecWithFlags->getUnderlyingValue());
2707 RecWithFlags->replaceAllUsesWith(New);
2708 RecWithFlags->eraseFromParent();
2709 CurRec = New;
2710 } else
2711 RecWithFlags->dropPoisonGeneratingFlags();
2712 } else {
2715 (void)Instr;
2716 assert((!Instr || !Instr->hasPoisonGeneratingFlags()) &&
2717 "found instruction with poison generating flags not covered by "
2718 "VPRecipeWithIRFlags");
2719 }
2720
2721 // Add new definitions to the worklist.
2722 for (VPValue *Operand : CurRec->operands())
2723 if (VPRecipeBase *OpDef = Operand->getDefiningRecipe())
2724 Worklist.push_back(OpDef);
2725 }
2726 });
2727
2728 // We want to exclude the tail folding case, as we don't need to drop flags
2729 // for operations computing the first lane in this case: the first lane of the
2730 // header mask must always be true. For reverse memory accesses, the mask is
2731 // wrapped in a Reverse, which is just a permutation of the header mask, so
2732 // peel it off before checking. The header mask is still the abstract region
2733 // value at this point (materialization happens later).
2734 auto m_UnlessHdrMask = m_Unless( // NOLINT
2736
2737 // Traverse all the recipes in the VPlan and collect the poison-generating
2738 // recipes in the backward slice starting at the address of a VPWidenRecipe or
2739 // VPInterleaveRecipe.
2740 auto Iter =
2743 for (VPRecipeBase &Recipe : *VPBB) {
2744 if (auto *WidenRec = dyn_cast<VPWidenMemoryRecipe>(&Recipe)) {
2745 VPRecipeBase *AddrDef = WidenRec->getAddr()->getDefiningRecipe();
2746 if (AddrDef && WidenRec->isConsecutive() && WidenRec->getMask() &&
2747 match(WidenRec->getMask(), m_UnlessHdrMask))
2748 CollectPoisonGeneratingInstrsInBackwardSlice(AddrDef);
2749 } else if (auto *InterleaveRec = dyn_cast<VPInterleaveRecipe>(&Recipe)) {
2750 VPRecipeBase *AddrDef = InterleaveRec->getAddr()->getDefiningRecipe();
2751 if (AddrDef && InterleaveRec->getMask() &&
2752 match(InterleaveRec->getMask(), m_UnlessHdrMask))
2753 CollectPoisonGeneratingInstrsInBackwardSlice(AddrDef);
2754 }
2755 }
2756 }
2757}
2758
2760 VPlan &Plan,
2762 &InterleaveGroups,
2763 const bool &EpilogueAllowed) {
2764 if (InterleaveGroups.empty())
2765 return;
2766
2768 for (VPBasicBlock *VPBB :
2771 for (VPRecipeBase &R : make_filter_range(*VPBB, [](VPRecipeBase &R) {
2772 return isa<VPWidenMemoryRecipe>(&R);
2773 })) {
2774 auto *MemR = cast<VPWidenMemoryRecipe>(&R);
2775 IRMemberToRecipe[&MemR->getIngredient()] = MemR;
2776 }
2777
2778 // Interleave memory: for each Interleave Group we marked earlier as relevant
2779 // for this VPlan, replace the Recipes widening its memory instructions with a
2780 // single VPInterleaveRecipe at its insertion point.
2781 VPDominatorTree VPDT(Plan);
2782 for (const auto *IG : InterleaveGroups) {
2783 VPWidenMemoryRecipe *Start = nullptr;
2784 Instruction *StartMember = nullptr;
2785 for (auto *Member : IG->members())
2786 if (VPWidenMemoryRecipe *R = IRMemberToRecipe.lookup(Member)) {
2787 StartMember = Member;
2788 Start = R;
2789 break;
2790 }
2791 if (!StartMember) // All member recipes are dead, so the group is dead.
2792 continue;
2793 VPIRMetadata InterleaveMD(*Start);
2794 SmallVector<VPValue *, 4> StoredValues;
2795 for (unsigned I = 0; I < IG->getFactor(); ++I) {
2796 Instruction *MemberI = IG->getMember(I);
2797 if (!MemberI)
2798 continue;
2799 if (VPWidenMemoryRecipe *MemoryR = IRMemberToRecipe.lookup(MemberI)) {
2800 if (auto *StoreR = dyn_cast<VPWidenStoreRecipe>(MemoryR->getAsRecipe()))
2801 StoredValues.push_back(StoreR->getStoredValue());
2802 InterleaveMD.intersect(*MemoryR);
2803 } else {
2804 InterleaveMD.intersect(VPIRMetadata(*MemberI));
2805 }
2806 }
2807
2808 bool NeedsMaskForGaps =
2809 (IG->requiresScalarEpilogue() && !EpilogueAllowed) ||
2810 (!StoredValues.empty() && !IG->isFull());
2811
2812 Instruction *IRInsertPos = IG->getInsertPos();
2813 auto *InsertPos = IRMemberToRecipe.lookup(IRInsertPos);
2814 if (!InsertPos) {
2815 // InsertPos member is dead: find a new member that is alive.
2816 assert(isa<VPWidenLoadRecipe>(Start->getAsRecipe()) &&
2817 "Dead member in non-load group?");
2818 InsertPos = Start;
2819 for (Instruction *Member : IG->members())
2820 if (VPWidenMemoryRecipe *MemberR = IRMemberToRecipe.lookup(Member))
2821 if (VPDT.properlyDominates(MemberR->getAsRecipe(),
2822 InsertPos->getAsRecipe()))
2823 InsertPos = MemberR;
2824 IRInsertPos = &InsertPos->getIngredient();
2825 }
2826 VPRecipeBase *InsertPosR = InsertPos->getAsRecipe();
2827
2829 if (auto *Gep = dyn_cast<GetElementPtrInst>(
2830 getLoadStorePointerOperand(IRInsertPos)->stripPointerCasts()))
2831 NW = Gep->getNoWrapFlags().withoutNoUnsignedWrap();
2832
2833 // Get or create the start address for the interleave group.
2834 VPValue *Addr = Start->getAddr();
2835 VPRecipeBase *AddrDef = Addr->getDefiningRecipe();
2836 if (IG->getIndex(StartMember) != 0 ||
2837 (AddrDef && !VPDT.properlyDominates(AddrDef, InsertPosR))) {
2838 // Either member zero's recipe is dead, or we cannot re-use the address of
2839 // member zero because it does not dominate the insert position. Instead,
2840 // use the address of the insert position and create a PtrAdd adjusting it
2841 // to the address of member zero.
2842 // TODO: Hoist Addr's defining recipe (and any operands as needed) to
2843 // InsertPos or sink loads above zero members to join it.
2844 assert(IG->getIndex(IRInsertPos) != 0 &&
2845 "index of insert position shouldn't be zero");
2846 auto &DL = IRInsertPos->getDataLayout();
2847 APInt Offset(32,
2848 DL.getTypeAllocSize(getLoadStoreType(IRInsertPos)) *
2849 IG->getIndex(IRInsertPos),
2850 /*IsSigned=*/true);
2851 VPValue *OffsetVPV = Plan.getConstantInt(-Offset);
2852 VPBuilder B(InsertPosR);
2853 Addr = B.createNoWrapPtrAdd(InsertPos->getAddr(), OffsetVPV, NW);
2854 }
2855 // If the group is reverse, adjust the index to refer to the last vector
2856 // lane instead of the first. We adjust the index from the first vector
2857 // lane, rather than directly getting the pointer for lane VF - 1, because
2858 // the pointer operand of the interleaved access is supposed to be uniform.
2859 if (IG->isReverse()) {
2860 auto *ReversePtr = new VPVectorEndPointerRecipe(
2861 Addr, &Plan.getVF(), getLoadStoreType(IRInsertPos),
2862 -(int64_t)IG->getFactor(), NW, InsertPosR->getDebugLoc());
2863 ReversePtr->insertBefore(InsertPosR);
2864 Addr = ReversePtr;
2865 }
2866 auto *VPIG = new VPInterleaveRecipe(
2867 IG, Addr, StoredValues, InsertPos->getMask(), NeedsMaskForGaps,
2868 InterleaveMD, InsertPosR->getDebugLoc());
2869 VPIG->insertBefore(InsertPosR);
2870
2871 unsigned J = 0;
2872 for (unsigned i = 0; i < IG->getFactor(); ++i)
2873 if (Instruction *Member = IG->getMember(i)) {
2874 VPWidenMemoryRecipe *MemberR = IRMemberToRecipe.lookup(Member);
2875 if (!Member->getType()->isVoidTy()) {
2876 if (MemberR) {
2877 VPValue *OriginalV = MemberR->getAsRecipe()->getVPSingleValue();
2878 OriginalV->replaceAllUsesWith(VPIG->getVPValue(J));
2879 }
2880 J++;
2881 }
2882 if (MemberR)
2883 MemberR->getAsRecipe()->eraseFromParent();
2884 }
2885 }
2886}
2887
2888/// Returns the VPValue representing the uncountable exit comparison used by
2889/// AnyOf if the recipes it depends on can be traced back to live-ins and
2890/// the addresses (in GEP/PtrAdd form) of any (non-masked) load used in
2891/// generating the values for the comparison. The recipes are stored in
2892/// \p Recipes.
2893static std::optional<VPValue *>
2895 VPBasicBlock *LatchVPBB) {
2896 // Given a plain CFG VPlan loop with countable latch exiting block
2897 // \p LatchVPBB, we're looking to match the recipes contributing to the
2898 // uncountable exit condition comparison (here, vp<%4>) back to either
2899 // live-ins or the address nodes for the load used as part of the uncountable
2900 // exit comparison so that we can either move them within the loop, or copy
2901 // them to the preheader depending on the chosen method for dealing with
2902 // stores in uncountable exit loops.
2903 //
2904 // Currently, the address of the load is restricted to a GEP with 2 operands
2905 // and a live-in base address. This constraint may be relaxed later.
2906 //
2907 // VPlan ' for UF>=1' {
2908 // Live-in vp<%0> = VF * UF
2909 // Live-in vp<%1> = vector-trip-count
2910 // Live-in ir<20> = original trip-count
2911 //
2912 // ir-bb<entry>:
2913 // Successor(s): scalar.ph, vector.ph
2914 //
2915 // vector.ph:
2916 // Successor(s): for.body
2917 //
2918 // for.body:
2919 // EMIT vp<%2> = phi ir<0>, vp<%index.next>
2920 // EMIT-SCALAR ir<%iv> = phi [ ir<0>, vector.ph ], [ ir<%iv.next>, for.inc ]
2921 // EMIT ir<%uncountable.addr> = getelementptr inbounds nuw ir<%pred>,ir<%iv>
2922 // EMIT ir<%uncountable.val> = load ir<%uncountable.addr>
2923 // EMIT ir<%uncountable.cond> = icmp sgt ir<%uncountable.val>, ir<500>
2924 // EMIT vp<%3> = masked-cond ir<%uncountable.cond>
2925 // Successor(s): for.inc
2926 //
2927 // for.inc:
2928 // EMIT ir<%iv.next> = add nuw nsw ir<%iv>, ir<1>
2929 // EMIT ir<%countable.cond> = icmp eq ir<%iv.next>, ir<20>
2930 // EMIT vp<%index.next> = add nuw vp<%2>, vp<%0>
2931 // EMIT vp<%4> = any-of ir<%3>
2932 // EMIT vp<%5> = icmp eq vp<%index.next>, vp<%1>
2933 // EMIT branch-on-two-conds vp<%4>, vp<%5>
2934 // Successor(s): middle.block, middle.block, for.body
2935 //
2936 // middle.block:
2937 // Successor(s): ir-bb<exit>, scalar.ph
2938 //
2939 // ir-bb<exit>:
2940 // No successors
2941 //
2942 // scalar.ph:
2943 // }
2944
2945 // Find the uncountable loop exit condition.
2946 VPValue *UncountableCondition = nullptr;
2947 if (!match(LatchVPBB->getTerminator(),
2948 m_BranchOnTwoConds(m_AnyOf(m_VPValue(UncountableCondition)),
2949 m_VPValue())))
2950 return std::nullopt;
2951
2953 Worklist.push_back(UncountableCondition);
2954 while (!Worklist.empty()) {
2955 VPValue *V = Worklist.pop_back_val();
2956
2957 // Any value defined outside the loop does not need to be copied.
2958 if (V->isDefinedOutsideLoopRegions())
2959 continue;
2960
2961 // FIXME: Remove the single user restriction; it's here because we're
2962 // starting with the simplest set of loops we can, and multiple
2963 // users means needing to add PHI nodes in the transform.
2964 if (V->getNumUsers() > 1)
2965 return std::nullopt;
2966
2967 VPValue *Op1, *Op2;
2968 // Walk back through recipes until we find at least one load from memory.
2969 if (match(V, m_ICmp(m_VPValue(Op1), m_VPValue(Op2)))) {
2970 Worklist.push_back(Op1);
2971 Worklist.push_back(Op2);
2972 Recipes.push_back(cast<VPInstruction>(V->getDefiningRecipe()));
2973 } else if (match(V, m_VPInstruction<Instruction::Load>(m_VPValue(Op1)))) {
2974 VPRecipeBase *GepR = Op1->getDefiningRecipe();
2975 // Only matching base + single offset term for now.
2976 if (GepR->getNumOperands() != 2)
2977 return std::nullopt;
2978 // Matching a GEP with a loop-invariant base ptr.
2980 m_LiveIn(), m_VPValue())))
2981 return std::nullopt;
2982 Recipes.push_back(cast<VPInstruction>(V->getDefiningRecipe()));
2983 Recipes.push_back(cast<VPInstruction>(GepR));
2985 m_VPValue(Op1)))) {
2986 Worklist.push_back(Op1);
2987 Recipes.push_back(cast<VPInstruction>(V->getDefiningRecipe()));
2988 } else
2989 return std::nullopt;
2990 }
2991
2992 // If we couldn't match anything, don't return the condition. It may be
2993 // defined outside the loop.
2994 if (Recipes.empty() ||
2996 return std::nullopt;
2997
2998 return UncountableCondition;
2999}
3000
3006
3007/// Update \p Plan to mask memory operations in the loop based on whether the
3008/// early exit is taken or not.
3009///
3010/// We're currently expecting to find a loop with properties similar to the
3011/// following:
3012///
3013/// for.body:
3014/// ir<%indvars.iv> = WIDEN-INDUCTION nuw nsw ir<0>, ir<1>, vp<%0>
3015/// EMIT ir<%arrayidx> = getelementptr inbounds nuw ir<@c>, ir<%indvars.iv>
3016/// EMIT-SCALAR ir<%0> = load ir<%arrayidx>
3017/// EMIT ir<%cmp1> = icmp sgt ir<%0>, ir<5>
3018/// EMIT vp<%1> = masked-cond ir<%cmp1>
3019/// Successor(s): if.end
3020///
3021/// if.end:
3022/// EMIT ir<%arrayidx3> = getelementptr inbounds nuw ir<@src>, ir<%indvars.iv>
3023/// EMIT-SCALAR ir<%2> = load ir<%arrayidx3>
3024/// EMIT ir<%add> = add nsw ir<%2>, ir<42>
3025/// EMIT ir<%arrayidx5> = getelementptr inbounds nuw ir<@dst>, ir<%indvars.iv>
3026/// EMIT store ir<%add>, ir<%arrayidx5>
3027/// EMIT ir<%indvars.iv.next> = add nuw nsw ir<%indvars.iv>, ir<1>
3028/// EMIT vp<%3> = any-of ir<%1>
3029/// EMIT ir<%exitcond.not> = icmp eq ir<%indvars.iv.next>, ir<10000>
3030/// EMIT branch-on-two-conds vp<%3>, ir<%exitcond.not>
3031/// Successor(s): middle.block, middle.block, for.body
3032///
3033/// We currently expect LoopVectorizationLegality to ensure that:
3034/// * There must also be a counted exit. We will need to support speculative
3035/// or first-faulting loads before we can remove this restriction.
3036/// * Any stores within the loop must not alias with the load used for the
3037/// uncountable exit. We can relax this a bit with runtime aliasing checks.
3038/// * Other memory operations in the loop can take place before or after the
3039/// uncountable exit, but must also be unconditional. We need to support
3040/// combining the conditions in VPlanPredicator.
3041/// * The loop must have a single unconditional load contributing to the
3042/// uncountable exit comparison, and the other term must be loop-invariant.
3043/// Improving upon this requires work in getRecipesForUncountableExit to
3044/// handle more complex recipe graphs.
3047 VPBasicBlock *HeaderVPBB, VPBasicBlock *LatchVPBB, VPBasicBlock *MiddleVPBB,
3048 Loop *TheLoop, PredicatedScalarEvolution &PSE, DominatorTree &DT,
3049 AssumptionCache *AC) {
3050
3051 // Disconnect early exiting blocks from successors, remove branches. We
3052 // currently don't support multiple uses for recipes involved in creating
3053 // the uncountable exit condition.
3054 for (auto &Exit : Exits) {
3055 if (Exit.EarlyExitingVPBB == LatchVPBB)
3056 continue;
3057
3058 for (VPRecipeBase &R : Exit.EarlyExitVPBB->phis())
3059 cast<VPIRPhi>(&R)->removeIncomingValueFor(Exit.EarlyExitingVPBB);
3060 Exit.EarlyExitingVPBB->getTerminator()->eraseFromParent();
3061 VPBlockUtils::disconnectBlocks(Exit.EarlyExitingVPBB, Exit.EarlyExitVPBB);
3062 }
3063
3064 VPDominatorTree VPDT(Plan);
3065
3066 // We can abandon a VPlan entirely if we return false here, so we shouldn't
3067 // crash if some earlier assumptions on scalar IR don't hold for the vplan
3068 // version of the loop.
3069 SmallVector<VPInstruction *, 8> ConditionRecipes;
3070
3071 std::optional<VPValue *> Cond =
3072 getRecipesForUncountableExit(ConditionRecipes, LatchVPBB);
3073 if (!Cond)
3074 return false;
3075
3076 // Find load contributing to condition.
3077 // At the moment LoopVectorizationLegality only supports a single
3078 // early-exit expression with a compare and a single load that must
3079 // be unconditional.
3080 // TODO: Support more than one load.
3081 auto *Load =
3082 find_singleton<VPInstruction>(ConditionRecipes, [](auto *I, bool _) {
3084 ? I
3085 : nullptr;
3086 });
3087 assert(Load && "Couldn't find exactly one load");
3088 // TODO: Support conditional loads for uncountable exits.
3089 assert(VPDT.dominates(Load->getParent(), LatchVPBB) &&
3090 "Uncountable exit condition load is conditional.");
3091 VPInstruction *Ptr = cast<VPInstruction>(Load->getOperand(0));
3092
3093 // Ensure that we are guaranteed to be able to dereference the memory used
3094 // for determining the uncountable exit for the maximum possible number of
3095 // scalar iterations of the loop.
3096 //
3097 // TODO: Support first-faulting loads in cases where we don't know whether
3098 // all possible addresses are dereferenceable.
3099 {
3101 const SCEV *PtrSCEV = vputils::getSCEVExprForVPValue(Ptr, PSE, TheLoop);
3102 const DataLayout &DL = Plan.getDataLayout();
3103 APInt EltSize(DL.getIndexTypeSizeInBits(Ptr->getScalarType()),
3104 DL.getTypeStoreSize(Load->getScalarType()).getFixedValue());
3106 PtrSCEV, cast<LoadInst>(Load->getUnderlyingInstr())->getAlign(),
3107 PSE.getSE()->getConstant(EltSize), TheLoop, *PSE.getSE(), DT, AC,
3108 &Predicates))
3109 return false;
3110 }
3111
3112 // Check for a single GEP for the condition load to see if we can link it to
3113 // a widen IV recipe with a step of 1; we're only interested in contiguous
3114 // accesses for the condition load right now.
3115 auto *IV = cast<VPWidenInductionRecipe>(&HeaderVPBB->front());
3116 if (!match(IV->getStartValue(), m_SpecificInt(0)) ||
3117 !match(IV->getStepValue(), m_SpecificInt(1)))
3118 return false;
3120 m_Specific(IV))))
3121 return false;
3122
3123 // We want to guarantee that the uncountable exit condition (and the mask
3124 // we will generate from it) are available for all operations in the loop
3125 // that need to be masked. If the condition recipes are not already the first
3126 // recipes in the header after the last phi, move them there.
3127 auto InsertIt = HeaderVPBB->getFirstNonPhi();
3128 while (InsertIt != HeaderVPBB->end() &&
3129 is_contained(ConditionRecipes, &*InsertIt)) {
3130 erase(ConditionRecipes, &*InsertIt);
3131 InsertIt++;
3132 }
3133 for (auto *Recipe : reverse(ConditionRecipes))
3134 Recipe->moveBefore(*HeaderVPBB, InsertIt);
3135
3136 // Create a mask to represent all lanes that fully execute in the vector loop,
3137 // stopping short of any early exit.
3138 VPBuilder MaskBuilder(HeaderVPBB, InsertIt);
3139 VPValue *FirstActive = MaskBuilder.createFirstActiveLane(*Cond);
3140 Type *IVScalarTy = IV->getScalarType();
3141 VPValue *Zero = Plan.getZero(IVScalarTy);
3142 FirstActive =
3143 MaskBuilder.createScalarZExtOrTrunc(FirstActive, IVScalarTy, DebugLoc());
3145 {Zero, FirstActive}, DebugLoc(),
3146 "uncountable.exit.mask");
3147
3148 // Convert all other memory operations to use the mask.
3149 for (VPBasicBlock *VPBB : vp_rpo_plain_cfg_loop_body(HeaderVPBB))
3150 for (VPRecipeBase &R : *VPBB)
3151 if (R.mayReadOrWriteMemory() && &R != Load) {
3152 // TODO: Handle conditional memory operations in the loop.
3153 if (!VPDT.dominates(R.getParent(), LatchVPBB))
3154 return false;
3155 cast<VPInstruction>(&R)->addMask(Mask);
3156 }
3157
3158 // Update middle block branch to compare (IV + however many lanes were active)
3159 // against the full trip count, since we may be exiting the vector loop early.
3160 // If we didn't take an early exit, we should get the equivalent of VF from
3161 // the FirstActiveLane.
3162 assert(match(MiddleVPBB->getTerminator(), m_BranchOnCond()) &&
3163 "Expected BranchOnCond terminator for MiddleVPBB");
3164 VPBuilder MiddleBuilder(MiddleVPBB->getTerminator());
3165 VPValue *ScalarIV = MiddleBuilder.createNaryOp(VPInstruction::ExtractLane,
3166 {Zero, IV}, DebugLoc());
3167 VPValue *ExitIV = MiddleBuilder.createAdd(ScalarIV, FirstActive);
3168 VPValue *FullTC =
3169 MiddleBuilder.createICmp(CmpInst::ICMP_EQ, ExitIV, Plan.getTripCount());
3170 MiddleVPBB->getTerminator()->setOperand(0, FullTC);
3171
3172 // Update resume phi in scalar.ph.
3173 VPBasicBlock *ScalarPH = Plan.getScalarPreheader();
3174 auto Phis = ScalarPH->phis();
3175 // TODO: Handle more than one Phi; re-derive from IV.
3176 // TODO: Handle reductions.
3177 if (range_size(Phis) != 1)
3178 return false;
3179 VPPhi *ContinueIV = cast<VPPhi>(Phis.begin());
3180 // Make sure we're referring to the same IV.
3181 assert(
3182 match(ContinueIV->getOperand(0),
3184 "Continuing from different IV");
3185 ContinueIV->setOperand(0, ExitIV);
3186 return true;
3187}
3188
3190 VPlan &Plan, Loop *TheLoop, PredicatedScalarEvolution &PSE,
3192#ifndef NDEBUG
3193 VPDominatorTree VPDT(Plan);
3194#endif
3195
3196 auto *MiddleVPBB = VPBlockUtils::getPlainCFGMiddleBlock(Plan);
3197 auto [HeaderVPBB, LatchVPBB] = VPBlockUtils::getPlainCFGHeaderAndLatch(Plan);
3198
3199 // Dereferenceability is checked separately for uncountable exit loops with
3200 // stores, as only the loads contributing to the exit condition need to
3201 // be checked.
3202 if (Style == UncountableExitStyle::ReadOnly &&
3203 !areAllLoadsDereferenceable(HeaderVPBB, TheLoop, PSE, DT, AC))
3204 return false;
3205
3206 VPBuilder LatchBuilder(LatchVPBB->getTerminator());
3208 for (auto [EarlyExitingVPBB, ExitBlock] :
3209 vputils::getEarlyExits(Plan, MiddleVPBB)) {
3210 // Collect condition for this early exit.
3211 VPBlockBase *TrueSucc = EarlyExitingVPBB->getSuccessors()[0];
3212 VPValue *CondOfEarlyExitingVPBB;
3213 [[maybe_unused]] bool Matched =
3214 match(EarlyExitingVPBB->getTerminator(),
3215 m_BranchOnCond(m_VPValue(CondOfEarlyExitingVPBB)));
3216 assert(Matched && "Terminator must be BranchOnCond");
3217
3218 // Insert the MaskedCond in the EarlyExitingVPBB so the predicator adds
3219 // the correct block mask.
3220 VPBuilder EarlyExitingBuilder(EarlyExitingVPBB->getTerminator());
3221 auto *CondToEarlyExit = EarlyExitingBuilder.createNaryOp(
3223 TrueSucc == ExitBlock
3224 ? CondOfEarlyExitingVPBB
3225 : EarlyExitingBuilder.createNot(CondOfEarlyExitingVPBB));
3226 assert((isa<VPIRValue>(CondOfEarlyExitingVPBB) ||
3227 !VPDT.properlyDominates(EarlyExitingVPBB, LatchVPBB) ||
3228 VPDT.properlyDominates(
3229 CondOfEarlyExitingVPBB->getDefiningRecipe()->getParent(),
3230 LatchVPBB)) &&
3231 "exit condition must dominate the latch");
3232 Exits.push_back({
3233 EarlyExitingVPBB,
3234 ExitBlock,
3235 CondToEarlyExit,
3236 });
3237 }
3238
3239 assert(!Exits.empty() && "must have at least one early exit");
3240 // Sort exits by RPO order to get correct program order. RPO gives a
3241 // topological ordering of the CFG, ensuring upstream exits are checked
3242 // before downstream exits in the dispatch chain.
3244 HeaderVPBB);
3246 for (const auto &[Num, VPB] : enumerate(RPOT))
3247 RPOIdx[VPB] = Num;
3248 llvm::sort(Exits, [&RPOIdx](const EarlyExitInfo &A, const EarlyExitInfo &B) {
3249 return RPOIdx[A.EarlyExitingVPBB] < RPOIdx[B.EarlyExitingVPBB];
3250 });
3251#ifndef NDEBUG
3252 // After RPO sorting, verify that for any pair where one exit dominates
3253 // another, the dominating exit comes first. This is guaranteed by RPO
3254 // (topological order) and is required for the dispatch chain correctness.
3255 for (unsigned I = 0; I + 1 < Exits.size(); ++I)
3256 for (unsigned J = I + 1; J < Exits.size(); ++J)
3257 assert(!VPDT.properlyDominates(Exits[J].EarlyExitingVPBB,
3258 Exits[I].EarlyExitingVPBB) &&
3259 "RPO sort must place dominating exits before dominated ones");
3260#endif
3261
3262 // Build the AnyOf condition for the latch terminator using logical OR
3263 // to avoid poison propagation from later exit conditions when an earlier
3264 // exit is taken.
3265 VPValue *Combined = Exits[0].CondToExit;
3266 for (const EarlyExitInfo &Info : drop_begin(Exits))
3267 Combined = LatchBuilder.createLogicalOr(Combined, Info.CondToExit);
3268
3269 VPValue *IsAnyExitTaken =
3270 LatchBuilder.createNaryOp(VPInstruction::AnyOf, {Combined});
3271
3272 // Create a comparison for the latch exit condition and replace the
3273 // BranchOnCond with a BranchOnTwoConds. The original BranchOnCond's condition
3274 // is used as the latch-exit condition; canonical IV recipes have not been
3275 // introduced yet, so there is no BranchOnCount to derive the condition from.
3276 auto *LatchExitingBranch = cast<VPInstruction>(LatchVPBB->getTerminator());
3277 assert(LatchExitingBranch->getOpcode() == VPInstruction::BranchOnCond &&
3278 "Unexpected terminator");
3279 VPValue *IsLatchExitTaken = LatchExitingBranch->getOperand(0);
3280 DebugLoc LatchDL = LatchExitingBranch->getDebugLoc();
3281 LatchExitingBranch->eraseFromParent();
3282 LatchBuilder.setInsertPoint(LatchVPBB);
3284 {IsAnyExitTaken, IsLatchExitTaken}, LatchDL);
3285 LatchVPBB->clearSuccessors();
3286
3288 // If handling the exiting lane in the scalar loop, combine the exit
3289 // conditions into a single BranchOnCond.
3290 LatchVPBB->setSuccessors({MiddleVPBB, MiddleVPBB, HeaderVPBB});
3291 MiddleVPBB->clearPredecessors();
3292 MiddleVPBB->setPredecessors({LatchVPBB, LatchVPBB});
3294 Plan, Exits, HeaderVPBB, LatchVPBB, MiddleVPBB, TheLoop, PSE, DT, AC);
3295 }
3296
3297 // Create the vector.early.exit blocks.
3298 SmallVector<VPBasicBlock *> VectorEarlyExitVPBBs(Exits.size());
3299 for (unsigned Idx = 0; Idx != Exits.size(); ++Idx) {
3300 Twine BlockSuffix = Exits.size() == 1 ? "" : Twine(".") + Twine(Idx);
3301 VPBasicBlock *VectorEarlyExitVPBB =
3302 Plan.createVPBasicBlock("vector.early.exit" + BlockSuffix);
3303 VectorEarlyExitVPBBs[Idx] = VectorEarlyExitVPBB;
3304 }
3305
3306 // Create the dispatch block (or reuse the single exit block if only one
3307 // exit). The dispatch block computes the first active lane of the combined
3308 // condition and, for multiple exits, chains through conditions to determine
3309 // which exit to take.
3310 VPBasicBlock *DispatchVPBB =
3311 Exits.size() == 1 ? VectorEarlyExitVPBBs[0]
3312 : Plan.createVPBasicBlock("vector.early.exit.check");
3313 DispatchVPBB->setPredecessors({LatchVPBB});
3314 LatchVPBB->setSuccessors({DispatchVPBB, MiddleVPBB, HeaderVPBB});
3315 VPBuilder DispatchBuilder(DispatchVPBB, DispatchVPBB->begin());
3316 VPValue *FirstActiveLane = DispatchBuilder.createFirstActiveLane(
3317 {Combined}, DebugLoc::getUnknown(), "first.active.lane");
3318
3319 // For each early exit, disconnect the original exiting block
3320 // (early.exiting.I) from the exit block (ir-bb<exit.I>) and route through a
3321 // new vector.early.exit block. Update ir-bb<exit.I>'s phis to extract their
3322 // values at the first active lane:
3323 //
3324 // Input:
3325 // early.exiting.I:
3326 // ...
3327 // EMIT branch-on-cond vp<%cond.I>
3328 // Successor(s): in.loop.succ, ir-bb<exit.I>
3329 //
3330 // ir-bb<exit.I>:
3331 // IR %phi = phi [ vp<%incoming.I>, early.exiting.I ], ...
3332 //
3333 // Output:
3334 // early.exiting.I:
3335 // ...
3336 // Successor(s): in.loop.succ
3337 //
3338 // vector.early.exit.I:
3339 // EMIT vp<%exit.val> = extract-lane vp<%first.lane>, vp<%incoming.I>
3340 // Successor(s): ir-bb<exit.I>
3341 //
3342 // ir-bb<exit.I>:
3343 // IR %phi = phi ... (extra operand: vp<%exit.val> from
3344 // vector.early.exit.I)
3345 //
3346 for (auto [Exit, VectorEarlyExitVPBB] :
3347 zip_equal(Exits, VectorEarlyExitVPBBs)) {
3348 auto &[EarlyExitingVPBB, EarlyExitVPBB, _] = Exit;
3349 // Adjust the phi nodes in EarlyExitVPBB.
3350 // 1. remove incoming values from EarlyExitingVPBB,
3351 // 2. extract the incoming value at FirstActiveLane
3352 // 3. add back the extracts as last operands for the phis
3353 // Then adjust the CFG, removing the edge between EarlyExitingVPBB and
3354 // EarlyExitVPBB and adding a new edge between VectorEarlyExitVPBB and
3355 // EarlyExitVPBB. The extracts at FirstActiveLane are now the incoming
3356 // values from VectorEarlyExitVPBB.
3357 for (VPRecipeBase &R : EarlyExitVPBB->phis()) {
3358 auto *ExitIRI = cast<VPIRPhi>(&R);
3359 VPValue *IncomingVal =
3360 ExitIRI->getIncomingValueForBlock(EarlyExitingVPBB);
3361 VPValue *NewIncoming = IncomingVal;
3362 if (!isa<VPIRValue>(IncomingVal)) {
3363 VPBuilder EarlyExitBuilder(VectorEarlyExitVPBB);
3364 NewIncoming = EarlyExitBuilder.createNaryOp(
3365 VPInstruction::ExtractLane, {FirstActiveLane, IncomingVal},
3366 DebugLoc::getUnknown(), "early.exit.value");
3367 }
3368 ExitIRI->removeIncomingValueFor(EarlyExitingVPBB);
3369 ExitIRI->addIncoming(NewIncoming);
3370 }
3371
3372 EarlyExitingVPBB->getTerminator()->eraseFromParent();
3373 VPBlockUtils::disconnectBlocks(EarlyExitingVPBB, EarlyExitVPBB);
3374 VPBlockUtils::connectBlocks(VectorEarlyExitVPBB, EarlyExitVPBB);
3375 }
3376
3377 // Chain through exits: for each exit, check if its condition is true at
3378 // the first active lane. If so, take that exit; otherwise, try the next.
3379 // The last exit needs no check since it must be taken if all others fail.
3380 //
3381 // For 3 exits (cond.0, cond.1, cond.2), this creates:
3382 //
3383 // latch:
3384 // ...
3385 // EMIT vp<%combined> = logical-or vp<%cond.0>, vp<%cond.1>, vp<%cond.2>
3386 // ...
3387 //
3388 // vector.early.exit.check:
3389 // EMIT vp<%first.lane> = first-active-lane vp<%combined>
3390 // EMIT vp<%at.cond.0> = extract-lane vp<%first.lane>, vp<%cond.0>
3391 // EMIT branch-on-cond vp<%at.cond.0>
3392 // Successor(s): vector.early.exit.0, vector.early.exit.check.0
3393 //
3394 // vector.early.exit.check.0:
3395 // EMIT vp<%at.cond.1> = extract-lane vp<%first.lane>, vp<%cond.1>
3396 // EMIT branch-on-cond vp<%at.cond.1>
3397 // Successor(s): vector.early.exit.1, vector.early.exit.2
3398 VPBasicBlock *CurrentBB = DispatchVPBB;
3399 for (auto [I, Exit] : enumerate(ArrayRef(Exits).drop_back())) {
3400 VPValue *LaneVal = DispatchBuilder.createNaryOp(
3401 VPInstruction::ExtractLane, {FirstActiveLane, Exit.CondToExit},
3402 DebugLoc::getUnknown(), "exit.cond.at.lane");
3403
3404 // For the last dispatch, branch directly to the last exit on false;
3405 // otherwise, create a new check block.
3406 bool IsLastDispatch = (I + 2 == Exits.size());
3407 VPBasicBlock *FalseBB =
3408 IsLastDispatch ? VectorEarlyExitVPBBs.back()
3409 : Plan.createVPBasicBlock(
3410 Twine("vector.early.exit.check.") + Twine(I));
3411
3412 DispatchBuilder.createNaryOp(VPInstruction::BranchOnCond, {LaneVal});
3413 CurrentBB->setSuccessors({VectorEarlyExitVPBBs[I], FalseBB});
3414 VectorEarlyExitVPBBs[I]->setPredecessors({CurrentBB});
3415 FalseBB->setPredecessors({CurrentBB});
3416
3417 CurrentBB = FalseBB;
3418 DispatchBuilder.setInsertPoint(CurrentBB);
3419 }
3420
3421 return true;
3422}
3423
3424/// This function tries convert extended in-loop reductions to
3425/// VPExpressionRecipe and clamp the \p Range if it is beneficial and
3426/// valid. The created recipe must be decomposed to its constituent
3427/// recipes before execution.
3428static VPExpressionRecipe *
3430 VFRange &Range) {
3431 Type *RedTy = Red->getScalarType();
3432 VPValue *VecOp = Red->getVecOp();
3433
3434 assert(!Red->isPartialReduction() &&
3435 "This path does not support partial reductions");
3436
3437 // Clamp the range if using extended-reduction is profitable.
3438 auto IsExtendedRedValidAndClampRange =
3439 [&](unsigned Opcode, Instruction::CastOps ExtOpc, Type *SrcTy) -> bool {
3441 [&](ElementCount VF) {
3442 auto *SrcVecTy = cast<VectorType>(toVectorTy(SrcTy, VF));
3444
3446 InstructionCost ExtCost =
3447 cast<VPWidenCastRecipe>(VecOp)->computeCost(VF, Ctx);
3448 InstructionCost RedCost = Red->computeCost(VF, Ctx);
3449
3450 assert(!RedTy->isFloatingPointTy() &&
3451 "getExtendedReductionCost only supports integer types");
3452 ExtRedCost = Ctx.TTI.getExtendedReductionCost(
3453 Opcode, ExtOpc == Instruction::CastOps::ZExt, RedTy, SrcVecTy,
3454 Red->getFastMathFlagsOrNone(), CostKind);
3455 return ExtRedCost.isValid() && ExtRedCost < ExtCost + RedCost;
3456 },
3457 Range);
3458 };
3459
3460 VPValue *A;
3461 // Match reduce(ext)).
3463 IsExtendedRedValidAndClampRange(
3464 RecurrenceDescriptor::getOpcode(Red->getRecurrenceKind()),
3465 cast<VPWidenCastRecipe>(VecOp)->getOpcode(), A->getScalarType()))
3466 return new VPExpressionRecipe(cast<VPWidenCastRecipe>(VecOp), Red);
3467
3468 return nullptr;
3469}
3470
3471/// This function tries convert extended in-loop reductions to
3472/// VPExpressionRecipe and clamp the \p Range if it is beneficial
3473/// and valid. The created VPExpressionRecipe must be decomposed to its
3474/// constituent recipes before execution. Patterns of the
3475/// VPExpressionRecipe:
3476/// reduce.add(mul(...)),
3477/// reduce.add(mul(ext(A), ext(B))),
3478/// reduce.add(ext(mul(ext(A), ext(B)))).
3479/// reduce.fadd(fmul(ext(A), ext(B)))
3480static VPExpressionRecipe *
3482 VPCostContext &Ctx, VFRange &Range) {
3483 unsigned Opcode = RecurrenceDescriptor::getOpcode(Red->getRecurrenceKind());
3484 if (Opcode != Instruction::Add && Opcode != Instruction::Sub &&
3485 Opcode != Instruction::FAdd)
3486 return nullptr;
3487
3488 assert(!Red->isPartialReduction() &&
3489 "This path does not support partial reductions");
3490 Type *RedTy = Red->getScalarType();
3491
3492 // Clamp the range if using multiply-accumulate-reduction is profitable.
3493 auto IsMulAccValidAndClampRange =
3495 VPWidenCastRecipe *OuterExt) -> bool {
3497 [&](ElementCount VF) {
3499 Type *SrcTy = Ext0 ? Ext0->getOperand(0)->getScalarType() : RedTy;
3500 InstructionCost MulAccCost;
3501
3502 // getMulAccReductionCost for in-loop reductions does not support
3503 // mixed or floating-point extends.
3504 if (Ext0 && Ext1 &&
3505 (Ext0->getOpcode() != Ext1->getOpcode() ||
3506 Ext0->getOpcode() == Instruction::CastOps::FPExt))
3507 return false;
3508
3509 bool IsZExt =
3510 !Ext0 || Ext0->getOpcode() == Instruction::CastOps::ZExt;
3511 auto *SrcVecTy = cast<VectorType>(toVectorTy(SrcTy, VF));
3512 MulAccCost = Ctx.TTI.getMulAccReductionCost(IsZExt, Opcode, RedTy,
3513 SrcVecTy, CostKind);
3514
3515 InstructionCost MulCost = Mul->computeCost(VF, Ctx);
3516 InstructionCost RedCost = Red->computeCost(VF, Ctx);
3517 InstructionCost ExtCost = 0;
3518 if (Ext0)
3519 ExtCost += Ext0->computeCost(VF, Ctx);
3520 if (Ext1)
3521 ExtCost += Ext1->computeCost(VF, Ctx);
3522 if (OuterExt)
3523 ExtCost += OuterExt->computeCost(VF, Ctx);
3524
3525 return MulAccCost.isValid() &&
3526 MulAccCost < ExtCost + MulCost + RedCost;
3527 },
3528 Range);
3529 };
3530
3531 VPValue *VecOp = Red->getVecOp();
3532 VPRecipeBase *Sub = nullptr;
3533 VPValue *A, *B;
3534 VPValue *Tmp = nullptr;
3535
3536 if (RedTy->isFloatingPointTy())
3537 return nullptr;
3538
3539 // Sub reductions could have a sub between the add reduction and vec op.
3540 if (match(VecOp, m_Sub(m_ZeroInt(), m_VPValue(Tmp)))) {
3541 Sub = VecOp->getDefiningRecipe();
3542 VecOp = Tmp;
3543 }
3544
3545 // If ValB is a constant and can be safely extended, truncate it to the same
3546 // type as ExtA's operand, then extend it to the same type as ExtA. This
3547 // creates two uniform extends that can more easily be matched by the rest of
3548 // the bundling code. The ExtB reference, ValB and operand 1 of Mul are all
3549 // replaced with the new extend of the constant.
3550 auto ExtendAndReplaceConstantOp = [](VPWidenCastRecipe *ExtA,
3551 VPWidenCastRecipe *&ExtB, VPValue *&ValB,
3552 VPWidenRecipe *Mul) {
3553 if (!ExtA || ExtB || !isa<VPIRValue>(ValB))
3554 return;
3555 Type *NarrowTy = ExtA->getOperand(0)->getScalarType();
3556 Instruction::CastOps ExtOpc = ExtA->getOpcode();
3557 const APInt *Const;
3558 if (!match(ValB, m_APInt(Const)) ||
3560 Const, NarrowTy, TTI::getPartialReductionExtendKind(ExtOpc)))
3561 return;
3562 // The truncate ensures that the type of each extended operand is the
3563 // same, and it's been proven that the constant can be extended from
3564 // NarrowTy safely. Necessary since ExtA's extended operand would be
3565 // e.g. an i8, while the const will likely be an i32. This will be
3566 // elided by later optimisations.
3567 VPBuilder Builder(Mul);
3568 auto *Trunc =
3569 Builder.createWidenCast(Instruction::CastOps::Trunc, ValB, NarrowTy);
3570 Type *WideTy = ExtA->getScalarType();
3571 ValB = ExtB = Builder.createWidenCast(ExtOpc, Trunc, WideTy);
3572 Mul->setOperand(1, ExtB);
3573 };
3574
3575 // Try to match reduce.add(mul(...)).
3576 if (match(VecOp, m_Mul(m_VPValue(A), m_VPValue(B)))) {
3577 auto *RecipeA = dyn_cast<VPWidenCastRecipe>(A);
3578 auto *RecipeB = dyn_cast<VPWidenCastRecipe>(B);
3579 auto *Mul = cast<VPWidenRecipe>(VecOp);
3580
3581 // Convert reduce.add(mul(ext, const)) to reduce.add(mul(ext, ext(const)))
3582 ExtendAndReplaceConstantOp(RecipeA, RecipeB, B, Mul);
3583
3584 // Match reduce.add/sub(mul(ext, ext)).
3585 if (RecipeA && RecipeB && match(RecipeA, m_ZExtOrSExt(m_VPValue())) &&
3586 match(RecipeB, m_ZExtOrSExt(m_VPValue())) &&
3587 IsMulAccValidAndClampRange(Mul, RecipeA, RecipeB, nullptr)) {
3588 if (Sub)
3589 return new VPExpressionRecipe(RecipeA, RecipeB, Mul,
3590 cast<VPWidenRecipe>(Sub), Red);
3591 return new VPExpressionRecipe(RecipeA, RecipeB, Mul, Red);
3592 }
3593 // TODO: Add an expression type for this variant with a negated mul
3594 if (!Sub && IsMulAccValidAndClampRange(Mul, nullptr, nullptr, nullptr))
3595 return new VPExpressionRecipe(Mul, Red);
3596 }
3597 // TODO: Add an expression type for negated versions of other expression
3598 // variants.
3599 if (Sub)
3600 return nullptr;
3601
3602 // Match reduce.add(ext(mul(A, B))).
3603 if (match(VecOp, m_ZExtOrSExt(m_Mul(m_VPValue(A), m_VPValue(B))))) {
3604 auto *Ext = cast<VPWidenCastRecipe>(VecOp);
3605 auto *Mul = cast<VPWidenRecipe>(Ext->getOperand(0));
3606 auto *Ext0 = dyn_cast<VPWidenCastRecipe>(A);
3607 auto *Ext1 = dyn_cast<VPWidenCastRecipe>(B);
3608
3609 // reduce.add(ext(mul(ext, const)))
3610 // -> reduce.add(ext(mul(ext, ext(const))))
3611 ExtendAndReplaceConstantOp(Ext0, Ext1, B, Mul);
3612
3613 // reduce.add(ext(mul(ext(A), ext(B))))
3614 // -> reduce.add(mul(wider_ext(A), wider_ext(B)))
3615 // The inner extends must either have the same opcode as the outer extend or
3616 // be the same, in which case the multiply can never result in a negative
3617 // value and the outer extend can be folded away by doing wider
3618 // extends for the operands of the mul.
3619 if (Ext0 && Ext1 &&
3620 (Ext->getOpcode() == Ext0->getOpcode() || Ext0 == Ext1) &&
3621 Ext0->getOpcode() == Ext1->getOpcode() &&
3622 IsMulAccValidAndClampRange(Mul, Ext0, Ext1, Ext) && Mul->hasOneUse()) {
3623 auto *NewExt0 = new VPWidenCastRecipe(
3624 Ext0->getOpcode(), Ext0->getOperand(0), Ext->getScalarType(), nullptr,
3625 *Ext0, *Ext0, Ext0->getDebugLoc());
3626 NewExt0->insertBefore(Ext0);
3627
3628 VPWidenCastRecipe *NewExt1 = NewExt0;
3629 if (Ext0 != Ext1) {
3630 NewExt1 = new VPWidenCastRecipe(Ext1->getOpcode(), Ext1->getOperand(0),
3631 Ext->getScalarType(), nullptr, *Ext1,
3632 *Ext1, Ext1->getDebugLoc());
3633 NewExt1->insertBefore(Ext1);
3634 }
3635 auto *NewMul = Mul->cloneWithOperands({NewExt0, NewExt1});
3636 NewMul->insertBefore(Mul);
3637 Ext->replaceAllUsesWith(NewMul);
3638 Ext->eraseFromParent();
3639 Mul->eraseFromParent();
3640 return new VPExpressionRecipe(NewExt0, NewExt1, NewMul, Red);
3641 }
3642 }
3643 return nullptr;
3644}
3645
3646/// This function tries to create abstract recipes from the reduction recipe for
3647/// following optimizations and cost estimation.
3649 VPCostContext &Ctx,
3650 VFRange &Range) {
3651 // Creation of VPExpressions for partial reductions is entirely handled in
3652 // transformToPartialReduction.
3653 assert(!Red->isPartialReduction() &&
3654 "This path does not support partial reductions");
3655
3656 VPExpressionRecipe *AbstractR = nullptr;
3657 auto IP = std::next(Red->getIterator());
3658 auto *VPBB = Red->getParent();
3659 if (auto *MulAcc = tryToMatchAndCreateMulAccumulateReduction(Red, Ctx, Range))
3660 AbstractR = MulAcc;
3661 else if (auto *ExtRed = tryToMatchAndCreateExtendedReduction(Red, Ctx, Range))
3662 AbstractR = ExtRed;
3663 // Cannot create abstract inloop reduction recipes.
3664 if (!AbstractR)
3665 return;
3666
3667 AbstractR->insertBefore(*VPBB, IP);
3668 Red->replaceAllUsesWith(AbstractR);
3669}
3670
3681
3682// Collect common metadata from a group of replicate recipes by intersecting
3683// metadata from all recipes in the group.
3685 VPIRMetadata CommonMetadata = *Recipes.front();
3686 for (VPReplicateRecipe *Recipe : drop_begin(Recipes))
3687 CommonMetadata.intersect(*Recipe);
3688 return CommonMetadata;
3689}
3690
3691template <unsigned Opcode>
3695 const Loop *L) {
3696 static_assert(Opcode == Instruction::Load || Opcode == Instruction::Store,
3697 "Only Load and Store opcodes supported");
3698 [[maybe_unused]] constexpr bool IsLoad = (Opcode == Instruction::Load);
3699
3700 // For each address, collect operations with the same or complementary masks.
3703 Plan, PSE, L,
3704 [](VPReplicateRecipe *RepR) { return RepR->isPredicated(); });
3705 for (auto Recipes : Groups) {
3706 if (Recipes.size() < 2)
3707 continue;
3708
3710 map_range(Recipes, bind_back<getLoadStoreValueType>(IsLoad))) &&
3711 "Expected all recipes in group to have the same load-store type");
3712
3713 // Collect groups with the same or complementary masks.
3714 for (VPReplicateRecipe *&RecipeI : Recipes) {
3715 if (!RecipeI)
3716 continue;
3717
3718 VPValue *MaskI = RecipeI->getMask();
3720 Group.push_back(RecipeI);
3721 RecipeI = nullptr;
3722
3723 // Find all operations with the same or complementary masks.
3724 bool HasComplementaryMask = false;
3725 for (VPReplicateRecipe *&RecipeJ : Recipes) {
3726 if (!RecipeJ)
3727 continue;
3728
3729 VPValue *MaskJ = RecipeJ->getMask();
3730 // Check if any operation in the group has a complementary mask with
3731 // another, that is M1 == NOT(M2) or M2 == NOT(M1).
3732 HasComplementaryMask |= match(MaskI, m_Not(m_Specific(MaskJ))) ||
3733 match(MaskJ, m_Not(m_Specific(MaskI)));
3734 Group.push_back(RecipeJ);
3735 RecipeJ = nullptr;
3736 }
3737
3738 if (HasComplementaryMask) {
3739 assert(Group.size() >= 2 && "must have at least 2 entries");
3740 AllGroups.push_back(std::move(Group));
3741 }
3742 }
3743 }
3744
3745 return AllGroups;
3746}
3747
3748// Find the recipe with minimum alignment in the group.
3749template <typename InstType>
3750static VPReplicateRecipe *
3752 return *min_element(Group, [](VPReplicateRecipe *A, VPReplicateRecipe *B) {
3753 return cast<InstType>(A->getUnderlyingInstr())->getAlign() <
3754 cast<InstType>(B->getUnderlyingInstr())->getAlign();
3755 });
3756}
3757
3760 const Loop *L) {
3761 auto Groups =
3763 if (Groups.empty())
3764 return;
3765
3766 // Process each group of loads.
3767 for (auto &Group : Groups) {
3768 // Try to use the earliest (most dominating) load to replace all others.
3769 VPReplicateRecipe *EarliestLoad = Group[0];
3770 VPBasicBlock *FirstBB = EarliestLoad->getParent();
3771 VPBasicBlock *LastBB = Group.back()->getParent();
3772
3773 // Check that the load doesn't alias with stores between first and last.
3774 auto LoadLoc = vputils::getMemoryLocation(*EarliestLoad);
3775 if (!LoadLoc || !canHoistOrSinkWithNoAliasCheck(*LoadLoc, FirstBB, LastBB))
3776 continue;
3777
3778 // Collect common metadata from all loads in the group.
3779 VPIRMetadata CommonMetadata = getCommonMetadata(Group);
3780
3781 // Find the load with minimum alignment to use.
3782 auto *LoadWithMinAlign = findRecipeWithMinAlign<LoadInst>(Group);
3783
3784 bool IsSingleScalar = EarliestLoad->isSingleScalar();
3785 assert(all_of(Group,
3786 [IsSingleScalar](VPReplicateRecipe *R) {
3787 return R->isSingleScalar() == IsSingleScalar;
3788 }) &&
3789 "all members in group must agree on IsSingleScalar");
3790
3791 // Create an unpredicated version of the earliest load with common
3792 // metadata.
3793 auto *UnpredicatedLoad = new VPReplicateRecipe(
3794 LoadWithMinAlign->getUnderlyingInstr(), {EarliestLoad->getOperand(0)},
3795 IsSingleScalar, /*Mask=*/nullptr, *EarliestLoad, CommonMetadata);
3796
3797 UnpredicatedLoad->insertBefore(EarliestLoad);
3798
3799 // Replace all loads in the group with the unpredicated load.
3800 for (VPReplicateRecipe *Load : Group) {
3801 Load->replaceAllUsesWith(UnpredicatedLoad);
3802 Load->eraseFromParent();
3803 }
3804 }
3805}
3806
3807static bool
3809 PredicatedScalarEvolution &PSE, const Loop &L) {
3810 auto StoreLoc = vputils::getMemoryLocation(*StoresToSink.front());
3811 if (!StoreLoc || !StoreLoc->AATags.Scope)
3812 return false;
3813
3814 // When sinking a group of stores, all members of the group alias each other.
3815 // Skip them during the alias checks.
3816 VPBasicBlock *FirstBB = StoresToSink.front()->getParent();
3817 VPBasicBlock *LastBB = StoresToSink.back()->getParent();
3818 SinkStoreInfo SinkInfo(StoresToSink, *StoresToSink[0], PSE, L);
3819 return canHoistOrSinkWithNoAliasCheck(*StoreLoc, FirstBB, LastBB, SinkInfo);
3820}
3821
3824 const Loop *L) {
3825 auto Groups =
3827 if (Groups.empty())
3828 return;
3829
3830 for (auto &Group : Groups) {
3831 if (!canSinkStoreWithNoAliasCheck(Group, PSE, *L))
3832 continue;
3833
3834 // Use the last (most dominated) store's location for the unconditional
3835 // store.
3836 VPReplicateRecipe *LastStore = Group.back();
3837 VPBasicBlock *InsertBB = LastStore->getParent();
3838
3839 // Collect common alias metadata from all stores in the group.
3840 VPIRMetadata CommonMetadata = getCommonMetadata(Group);
3841
3842 // Build select chain for stored values.
3843 VPValue *SelectedValue = Group[0]->getOperand(0);
3844 VPBuilder Builder(InsertBB, LastStore->getIterator());
3845
3846 bool IsSingleScalar = Group[0]->isSingleScalar();
3847 for (unsigned I = 1; I < Group.size(); ++I) {
3848 assert(IsSingleScalar == Group[I]->isSingleScalar() &&
3849 "all members in group must agree on IsSingleScalar");
3850 VPValue *Mask = Group[I]->getMask();
3851 VPValue *Value = Group[I]->getOperand(0);
3852 SelectedValue = Builder.createSelect(
3853 Mask, Value, SelectedValue, Group[I]->getDebugLoc(), "",
3854 VPIRFlags::getDefaultFlags(Instruction::Select,
3855 Value->getScalarType()));
3856 }
3857
3858 // Find the store with minimum alignment to use.
3859 auto *StoreWithMinAlign = findRecipeWithMinAlign<StoreInst>(Group);
3860
3861 // Create unconditional store with selected value and common metadata.
3862 auto *UnpredicatedStore = new VPReplicateRecipe(
3863 StoreWithMinAlign->getUnderlyingInstr(),
3864 {SelectedValue, LastStore->getOperand(1)}, IsSingleScalar,
3865 /*Mask=*/nullptr, *LastStore, CommonMetadata);
3866 UnpredicatedStore->insertBefore(*InsertBB, LastStore->getIterator());
3867
3868 // Remove all predicated stores from the group.
3869 for (VPReplicateRecipe *Store : Group)
3870 Store->eraseFromParent();
3871 }
3872}
3873
3874/// Returns true if \p V is VPWidenLoadRecipe or VPInterleaveRecipe that can be
3875/// converted to a narrower recipe. \p V is used by a wide recipe that feeds a
3876/// store interleave group at index \p Idx, \p WideMember0 is the recipe feeding
3877/// the same interleave group at index 0. A VPWidenLoadRecipe can be narrowed to
3878/// an index-independent load if it feeds all wide ops at all indices (\p OpV
3879/// must be the operand at index \p OpIdx for both the recipe at lane 0, \p
3880/// WideMember0). A VPInterleaveRecipe can be narrowed to a wide load, if \p V
3881/// is defined at \p Idx of a load interleave group.
3882/// A live-in or recipe defined outside the loop region can be converted, if it
3883/// is the same across all lanes, or we can create a BuildVector for it.
3884static bool canNarrowLoad(VPSingleDefRecipe *WideMember0, unsigned OpIdx,
3885 VPValue *OpV, unsigned Idx, bool IsScalable) {
3886 VPValue *Member0Op = WideMember0->getOperand(OpIdx);
3887 if (Member0Op->isDefinedOutsideLoopRegions()) {
3888 // Operand matches Member0, broadcast across all fields for both live-ins
3889 // and recipes.
3890 if (Member0Op == OpV)
3891 return true;
3892 // Otherwise distinct per-field VPValues are assembled into a BuildVector.
3893 return !IsScalable && OpV->isDefinedOutsideLoopRegions() &&
3894 OpV->getScalarType() == Member0Op->getScalarType();
3895 }
3896 VPRecipeBase *Member0OpR = Member0Op->getDefiningRecipe();
3897 if (auto *W = dyn_cast<VPWidenLoadRecipe>(Member0OpR))
3898 // For scalable VFs, the narrowed plan processes vscale iterations at once,
3899 // so a shared wide load cannot be narrowed to a uniform scalar; bail out.
3900 return !IsScalable && !W->getMask() && W->isConsecutive() &&
3901 Member0Op == OpV;
3902 if (auto *IR = dyn_cast<VPInterleaveRecipe>(Member0OpR))
3903 return IR->getInterleaveGroup()->isFull() && IR->getVPValue(Idx) == OpV;
3904 return false;
3905}
3906
3907static bool canNarrowOps(ArrayRef<VPValue *> Ops, bool IsScalable) {
3909 auto *WideMember0 = dyn_cast<VPRecipeWithIRFlags>(Ops[0]);
3910 if (!WideMember0)
3911 return false;
3912 for (VPValue *V : Ops) {
3914 return false;
3915 auto *R = cast<VPRecipeWithIRFlags>(V);
3916 if (vputils::getOpcode(R) != vputils::getOpcode(WideMember0))
3917 return false;
3918 if (R->getScalarType() != WideMember0->getScalarType())
3919 return false;
3920 if (R->hasPredicate() && R->getPredicate() != WideMember0->getPredicate())
3921 return false;
3922 }
3923
3924 for (unsigned Idx = 0; Idx != WideMember0->getNumOperands(); ++Idx) {
3926 for (VPValue *Op : Ops)
3927 OpsI.push_back(Op->getDefiningRecipe()->getOperand(Idx));
3928
3929 if (canNarrowOps(OpsI, IsScalable))
3930 continue;
3931
3932 if (any_of(enumerate(OpsI), [WideMember0, Idx, IsScalable](const auto &P) {
3933 const auto &[OpIdx, OpV] = P;
3934 return !canNarrowLoad(WideMember0, Idx, OpV, OpIdx, IsScalable);
3935 }))
3936 return false;
3937 }
3938
3939 return true;
3940}
3941
3942/// Returns VF from \p VFs if \p IR is a full interleave group with factor and
3943/// number of members both equal to VF. The interleave group must also access
3944/// the full vector width.
3945static std::optional<ElementCount>
3948 const TargetTransformInfo &TTI) {
3949 if (!InterleaveR || InterleaveR->getMask())
3950 return std::nullopt;
3951
3952 Type *GroupElementTy = nullptr;
3953 if (InterleaveR->getStoredValues().empty()) {
3954 GroupElementTy = InterleaveR->getVPValue(0)->getScalarType();
3955 if (!all_of(InterleaveR->definedValues(), [GroupElementTy](VPValue *Op) {
3956 return Op->getScalarType() == GroupElementTy;
3957 }))
3958 return std::nullopt;
3959 } else {
3960 GroupElementTy = InterleaveR->getStoredValues()[0]->getScalarType();
3961 if (!all_of(InterleaveR->getStoredValues(), [GroupElementTy](VPValue *Op) {
3962 return Op->getScalarType() == GroupElementTy;
3963 }))
3964 return std::nullopt;
3965 }
3966
3967 auto IG = InterleaveR->getInterleaveGroup();
3968 if (IG->getFactor() != IG->getNumMembers())
3969 return std::nullopt;
3970
3971 auto GetVectorBitWidthForVF = [&TTI](ElementCount VF) {
3972 TypeSize Size = TTI.getRegisterBitWidth(
3975 assert(Size.isScalable() == VF.isScalable() &&
3976 "if Size is scalable, VF must be scalable and vice versa");
3977 return Size.getKnownMinValue();
3978 };
3979
3980 for (ElementCount VF : VFs) {
3981 unsigned MinVal = VF.getKnownMinValue();
3982 unsigned GroupSize = GroupElementTy->getScalarSizeInBits() * MinVal;
3983 if (IG->getFactor() == MinVal && GroupSize == GetVectorBitWidthForVF(VF))
3984 return {VF};
3985 }
3986 return std::nullopt;
3987}
3988
3989/// Returns true if \p VPValue is a narrow VPValue.
3990static bool isAlreadyNarrow(VPValue *VPV) {
3991 if (isa<VPIRValue>(VPV))
3992 return true;
3993 auto *RepR = dyn_cast<VPReplicateRecipe>(VPV);
3994 return RepR && RepR->isSingleScalar();
3995}
3996
3997// Convert the wide recipes defining the VPValues in \p Members feeding an
3998// interleave group to a single narrow variant. The first member is reused as
3999// the narrowed recipe. BuildVectors for live-in operands are inserted into \p
4000// Preheader.
4002 SmallPtrSetImpl<VPValue *> &NarrowedOps,
4003 VPBasicBlock *Preheader) {
4004 VPValue *V = Members.front();
4005 if (NarrowedOps.contains(V))
4006 return V;
4007
4008 if (V->isDefinedOutsideLoopRegions()) {
4009 assert(all_of(Members,
4010 [V](VPValue *M) {
4011 return M->isDefinedOutsideLoopRegions() &&
4012 M->getScalarType() == V->getScalarType();
4013 }) &&
4014 "expected distinct loop-invariant values of matching scalar type");
4015 auto *BV = new VPInstruction(VPInstruction::BuildVector, Members);
4016 Preheader->appendRecipe(BV);
4017 NarrowedOps.insert(BV);
4018 return BV;
4019 }
4020
4021 if (isAlreadyNarrow(V))
4022 return V;
4023
4024 VPRecipeBase *R = V->getDefiningRecipe();
4026 auto *WideMember0 = cast<VPRecipeWithIRFlags>(R);
4027 for (VPValue *Member : Members.drop_front())
4028 WideMember0->intersectFlags(*cast<VPRecipeWithIRFlags>(Member));
4029 for (unsigned Idx = 0, E = WideMember0->getNumOperands(); Idx != E; ++Idx) {
4031 for (VPValue *Member : Members)
4032 OpsI.push_back(Member->getDefiningRecipe()->getOperand(Idx));
4033 WideMember0->setOperand(
4034 Idx, narrowInterleaveGroupOp(OpsI, NarrowedOps, Preheader));
4035 }
4036 return V;
4037 }
4038
4039 if (auto *LoadGroup = dyn_cast<VPInterleaveRecipe>(R)) {
4040 // Narrow interleave group to wide load, as transformed VPlan will only
4041 // process one original iteration.
4042 auto *LI = cast<LoadInst>(LoadGroup->getInterleaveGroup()->getInsertPos());
4043 auto *L = VPBuilder(LoadGroup).createWidenLoad(
4044 *LI, LoadGroup->getAddr(), LoadGroup->getMask(), /*Consecutive=*/true,
4045 *LoadGroup, LoadGroup->getDebugLoc());
4046 NarrowedOps.insert(L);
4047 return L;
4048 }
4049
4050 if (auto *RepR = dyn_cast<VPReplicateRecipe>(R)) {
4051 assert(RepR->isSingleScalar() && RepR->getOpcode() == Instruction::Load &&
4052 "must be a single scalar load");
4053 NarrowedOps.insert(RepR);
4054 return RepR;
4055 }
4056
4057 auto *WideLoad = cast<VPWidenLoadRecipe>(R);
4058 VPValue *PtrOp = WideLoad->getAddr();
4059 if (auto *VecPtr = dyn_cast<VPVectorPointerRecipe>(PtrOp))
4060 PtrOp = VecPtr->getOperand(0);
4061 // Narrow wide load to uniform scalar load, as transformed VPlan will only
4062 // process one original iteration.
4063 auto *N = new VPReplicateRecipe(&WideLoad->getIngredient(), {PtrOp},
4064 /*IsUniform*/ true,
4065 /*Mask*/ nullptr, {}, *WideLoad);
4066 N->insertBefore(WideLoad);
4067 NarrowedOps.insert(N);
4068 return N;
4069}
4070
4071std::unique_ptr<VPlan>
4073 const TargetTransformInfo &TTI) {
4074 VPRegionBlock *VectorLoop = Plan.getVectorLoopRegion();
4075
4076 if (!VectorLoop)
4077 return nullptr;
4078
4079 // Only handle single-block loops for now.
4080 if (VectorLoop->getEntryBasicBlock() != VectorLoop->getExitingBasicBlock())
4081 return nullptr;
4082
4083 // Skip plans when we may not be able to properly narrow.
4084 VPBasicBlock *Exiting = VectorLoop->getExitingBasicBlock();
4085 if (!match(&Exiting->back(), m_BranchOnCount()))
4086 return nullptr;
4087
4088 assert(match(&Exiting->back(),
4090 m_Specific(&Plan.getVectorTripCount()))) &&
4091 "unexpected branch-on-count");
4092
4094 std::optional<ElementCount> VFToOptimize;
4095 for (auto &R : *VectorLoop->getEntryBasicBlock()) {
4098 continue;
4099
4100 // Bail out on recipes not supported at the moment:
4101 // * phi recipes other than the canonical induction
4102 // * recipes writing to memory except interleave groups
4103 // Only support plans with a canonical induction phi.
4104 if (R.isPhi())
4105 return nullptr;
4106
4107 auto *InterleaveR = dyn_cast<VPInterleaveRecipe>(&R);
4108 if (R.mayWriteToMemory() && !InterleaveR)
4109 return nullptr;
4110
4111 // Bail out if any recipe defines a vector value used outside the
4112 // vector loop region.
4113 if (any_of(R.definedValues(), [&](VPValue *V) {
4114 return any_of(V->users(), [&](VPUser *U) {
4115 auto *UR = cast<VPRecipeBase>(U);
4116 return UR->getParent()->getParent() != VectorLoop;
4117 });
4118 }))
4119 return nullptr;
4120
4121 // All other ops are allowed, but we reject uses that cannot be converted
4122 // when checking all allowed consumers (store interleave groups) below.
4123 if (!InterleaveR)
4124 continue;
4125
4126 // Try to find a single VF, where all interleave groups are consecutive and
4127 // saturate the full vector width. If we already have a candidate VF, check
4128 // if it is applicable for the current InterleaveR, otherwise look for a
4129 // suitable VF across the Plan's VFs.
4131 VFToOptimize ? SmallVector<ElementCount>({*VFToOptimize})
4132 : to_vector(Plan.vectorFactors());
4133 std::optional<ElementCount> NarrowedVF =
4134 isConsecutiveInterleaveGroup(InterleaveR, VFs, TTI);
4135 if (!NarrowedVF || (VFToOptimize && NarrowedVF != VFToOptimize))
4136 return nullptr;
4137 VFToOptimize = NarrowedVF;
4138
4139 // Skip read interleave groups.
4140 if (InterleaveR->getStoredValues().empty())
4141 continue;
4142
4143 // Narrow interleave groups, if all operands are already matching narrow
4144 // ops.
4145 auto *Member0 = InterleaveR->getStoredValues()[0];
4146 if (isAlreadyNarrow(Member0) &&
4147 all_of(InterleaveR->getStoredValues(), equal_to(Member0))) {
4148 StoreGroups.push_back(InterleaveR);
4149 continue;
4150 }
4151
4152 // For now, we only support full interleave groups storing load interleave
4153 // groups.
4154 if (all_of(enumerate(InterleaveR->getStoredValues()), [](auto Op) {
4155 VPRecipeBase *DefR = Op.value()->getDefiningRecipe();
4156 if (!DefR)
4157 return false;
4158 auto *IR = dyn_cast<VPInterleaveRecipe>(DefR);
4159 return IR && IR->getInterleaveGroup()->isFull() &&
4160 IR->getVPValue(Op.index()) == Op.value();
4161 })) {
4162 StoreGroups.push_back(InterleaveR);
4163 continue;
4164 }
4165
4166 // Check if all values feeding InterleaveR are matching wide recipes, which
4167 // operands that can be narrowed.
4168 if (!canNarrowOps(InterleaveR->getStoredValues(),
4169 VFToOptimize->isScalable()))
4170 return nullptr;
4171 StoreGroups.push_back(InterleaveR);
4172 }
4173
4174 if (StoreGroups.empty())
4175 return nullptr;
4176
4177 VPBasicBlock *MiddleVPBB = Plan.getMiddleBlock();
4178 bool RequiresScalarEpilogue =
4179 MiddleVPBB->getNumSuccessors() == 1 &&
4180 MiddleVPBB->getSingleSuccessor() == Plan.getScalarPreheader();
4181 // Bail out for tail-folding (middle block with a single successor to exit).
4182 if (MiddleVPBB->getNumSuccessors() != 2 && !RequiresScalarEpilogue)
4183 return nullptr;
4184
4185 // All interleave groups in Plan can be narrowed for VFToOptimize. Split the
4186 // original Plan into 2: a) a new clone which contains all VFs of Plan, except
4187 // VFToOptimize, and b) the original Plan with VFToOptimize as single VF.
4188 // TODO: Handle cases where only some interleave groups can be narrowed.
4189 std::unique_ptr<VPlan> NewPlan;
4190 if (size(Plan.vectorFactors()) != 1) {
4191 NewPlan = std::unique_ptr<VPlan>(Plan.duplicate());
4192 Plan.setVF(*VFToOptimize);
4193 NewPlan->removeVF(*VFToOptimize);
4194 }
4195
4196 // Convert InterleaveGroup \p R to a single VPWidenLoadRecipe.
4197 SmallPtrSet<VPValue *, 4> NarrowedOps;
4198 VPBasicBlock *Preheader = Plan.getVectorPreheader();
4199 // Narrow operation tree rooted at store groups.
4200 for (auto *StoreGroup : StoreGroups) {
4201 VPValue *Res = narrowInterleaveGroupOp(StoreGroup->getStoredValues(),
4202 NarrowedOps, Preheader);
4203 auto *SI =
4204 cast<StoreInst>(StoreGroup->getInterleaveGroup()->getInsertPos());
4205 VPBuilder(StoreGroup)
4206 .createWidenStore(*SI, StoreGroup->getAddr(), Res, nullptr,
4207 /*Consecutive=*/true, *StoreGroup,
4208 StoreGroup->getDebugLoc());
4209 StoreGroup->eraseFromParent();
4210 }
4211
4212 // Adjust induction to reflect that the transformed plan only processes one
4213 // original iteration.
4215 Type *CanIVTy = VectorLoop->getCanonicalIVType();
4216 VPBasicBlock *VectorPH = Plan.getVectorPreheader();
4217 VPBuilder PHBuilder(VectorPH, VectorPH->begin());
4218
4219 VPValue *UF = &Plan.getUF();
4220 VPValue *Step;
4221 if (VFToOptimize->isScalable()) {
4222 VPValue *VScale =
4223 PHBuilder.createElementCount(CanIVTy, ElementCount::getScalable(1));
4224 Step = PHBuilder.createOverflowingOp(Instruction::Mul, {VScale, UF},
4225 {true, false});
4226 Plan.getVF().replaceAllUsesWith(VScale);
4227 } else {
4228 Step = UF;
4229 Plan.getVF().replaceAllUsesWith(Plan.getConstantInt(CanIVTy, 1));
4230 }
4231 // Materialize vector trip count with the narrowed step.
4232 materializeVectorTripCount(Plan, VectorPH, /*TailByMasking=*/false,
4233 RequiresScalarEpilogue, Step);
4234
4235 CanIVInc->setOperand(1, Step);
4236 Plan.getVFxUF().replaceAllUsesWith(Step);
4237
4238 removeDeadRecipes(Plan);
4239 assert(none_of(*VectorLoop->getEntryBasicBlock(),
4241 "All VPVectorPointerRecipes should have been removed");
4242 return NewPlan;
4243}
4244
4246 VFRange &Range) {
4247 VPRegionBlock *VectorRegion = Plan.getVectorLoopRegion();
4248 auto *MiddleVPBB = Plan.getMiddleBlock();
4249 VPBuilder MiddleBuilder(MiddleVPBB, MiddleVPBB->getFirstNonPhi());
4250
4251 auto IsScalableOne = [](ElementCount VF) -> bool {
4252 return VF == ElementCount::getScalable(1);
4253 };
4254
4255 for (auto &HeaderPhi : VectorRegion->getEntryBasicBlock()->phis()) {
4256 auto *FOR = dyn_cast<VPFirstOrderRecurrencePHIRecipe>(&HeaderPhi);
4257 if (!FOR)
4258 continue;
4259
4260 assert(VectorRegion->getSingleSuccessor() == Plan.getMiddleBlock() &&
4261 "Cannot handle loops with uncountable early exits");
4262
4263 // Find the existing splice for this FOR, created in
4264 // createHeaderPhiRecipes. All uses of FOR have already been replaced with
4265 // RecurSplice there; only RecurSplice itself still references FOR.
4266 auto *RecurSplice =
4268 assert(RecurSplice && "expected FirstOrderRecurrenceSplice");
4269
4270 // For VF vscale x 1, if vscale = 1, we are unable to extract the
4271 // penultimate value of the recurrence. Instead we rely on the existing
4272 // extract of the last element from the result of
4273 // VPInstruction::FirstOrderRecurrenceSplice.
4274 // TODO: Consider vscale_range info and UF.
4275 if (any_of(RecurSplice->users(),
4276 [](VPUser *U) { return !cast<VPRecipeBase>(U)->getRegion(); }) &&
4278 Range))
4279 return;
4280
4281 // This is the second phase of vectorizing first-order recurrences, creating
4282 // extracts for users outside the loop. An overview of the transformation is
4283 // described below. Suppose we have the following loop with some use after
4284 // the loop of the last a[i-1],
4285 //
4286 // for (int i = 0; i < n; ++i) {
4287 // t = a[i - 1];
4288 // b[i] = a[i] - t;
4289 // }
4290 // use t;
4291 //
4292 // There is a first-order recurrence on "a". For this loop, the shorthand
4293 // scalar IR looks like:
4294 //
4295 // scalar.ph:
4296 // s.init = a[-1]
4297 // br scalar.body
4298 //
4299 // scalar.body:
4300 // i = phi [0, scalar.ph], [i+1, scalar.body]
4301 // s1 = phi [s.init, scalar.ph], [s2, scalar.body]
4302 // s2 = a[i]
4303 // b[i] = s2 - s1
4304 // br cond, scalar.body, exit.block
4305 //
4306 // exit.block:
4307 // use = lcssa.phi [s1, scalar.body]
4308 //
4309 // In this example, s1 is a recurrence because it's value depends on the
4310 // previous iteration. In the first phase of vectorization, we created a
4311 // VPFirstOrderRecurrencePHIRecipe v1 for s1. Now we create the extracts
4312 // for users in the scalar preheader and exit block.
4313 //
4314 // vector.ph:
4315 // v_init = vector(..., ..., ..., a[-1])
4316 // br vector.body
4317 //
4318 // vector.body
4319 // i = phi [0, vector.ph], [i+4, vector.body]
4320 // v1 = phi [v_init, vector.ph], [v2, vector.body]
4321 // v2 = a[i, i+1, i+2, i+3]
4322 // v1' = splice(v1(3), v2(0, 1, 2))
4323 // b[i, i+1, i+2, i+3] = v2 - v1'
4324 // br cond, vector.body, middle.block
4325 //
4326 // middle.block:
4327 // vector.recur.extract.for.phi = v2(2)
4328 // vector.recur.extract = v2(3)
4329 // br cond, scalar.ph, exit.block
4330 //
4331 // scalar.ph:
4332 // scalar.recur.init = phi [vector.recur.extract, middle.block],
4333 // [s.init, otherwise]
4334 // br scalar.body
4335 //
4336 // scalar.body:
4337 // i = phi [0, scalar.ph], [i+1, scalar.body]
4338 // s1 = phi [scalar.recur.init, scalar.ph], [s2, scalar.body]
4339 // s2 = a[i]
4340 // b[i] = s2 - s1
4341 // br cond, scalar.body, exit.block
4342 //
4343 // exit.block:
4344 // lo = lcssa.phi [s1, scalar.body],
4345 // [vector.recur.extract.for.phi, middle.block]
4346 //
4347 // Update extracts of the splice in the middle block: they extract the
4348 // penultimate element of the recurrence.
4350 make_range(MiddleVPBB->getFirstNonPhi(), MiddleVPBB->end()))) {
4351 if (!match(&R, m_ExtractLastLaneOfLastPart(m_Specific(RecurSplice))))
4352 continue;
4353
4354 auto *ExtractR = cast<VPInstruction>(&R);
4355 VPValue *PenultimateElement = MiddleBuilder.createNaryOp(
4356 VPInstruction::ExtractPenultimateElement, RecurSplice->getOperand(1),
4357 {}, "vector.recur.extract.for.phi");
4358 for (VPUser *ExitU : to_vector(ExtractR->users())) {
4359 if (auto *ExitPhi = dyn_cast<VPIRPhi>(ExitU))
4360 ExitPhi->replaceUsesOfWith(ExtractR, PenultimateElement);
4361 }
4362 }
4363 }
4364}
4365
4366/// Check if \p V is a binary expression of a widened IV and a loop-invariant
4367/// value. Returns the widened IV if found, nullptr otherwise.
4369 auto *BinOp = dyn_cast<VPWidenRecipe>(V);
4370 if (!BinOp || !Instruction::isBinaryOp(BinOp->getOpcode()) ||
4371 Instruction::isIntDivRem(BinOp->getOpcode()))
4372 return nullptr;
4373
4374 VPValue *WidenIVCandidate = BinOp->getOperand(0);
4375 VPValue *InvariantCandidate = BinOp->getOperand(1);
4376 if (!isa<VPWidenIntOrFpInductionRecipe>(WidenIVCandidate))
4377 std::swap(WidenIVCandidate, InvariantCandidate);
4378
4379 if (!InvariantCandidate->isDefinedOutsideLoopRegions())
4380 return nullptr;
4381
4382 return dyn_cast<VPWidenIntOrFpInductionRecipe>(WidenIVCandidate);
4383}
4384
4385/// Create a scalar version of \p BinOp, with its \p WidenIV operand replaced
4386/// by \p ScalarIV, and place it after \p ScalarIV's defining recipe.
4390 BinOp->getNumOperands() == 2 && "BinOp must have 2 operands");
4391 auto *ClonedOp = BinOp->clone();
4392 if (ClonedOp->getOperand(0) == WidenIV) {
4393 ClonedOp->setOperand(0, ScalarIV);
4394 } else {
4395 assert(ClonedOp->getOperand(1) == WidenIV && "one operand must be WideIV");
4396 ClonedOp->setOperand(1, ScalarIV);
4397 }
4398 ClonedOp->insertAfter(ScalarIV->getDefiningRecipe());
4399 return ClonedOp;
4400}
4401
4402/// If \p S is an affine AddRec, returns true if its step is known to be
4403/// positive and false if it is known to be negative. Returns std::nullopt if
4404/// \p S is not an affine AddRec, or if the sign of its step cannot be
4405/// determined.
4406static std::optional<bool> getStepDirection(const SCEV *S,
4407 ScalarEvolution &SE) {
4408 const SCEV *Step;
4409 if (!match(S, m_scev_AffineAddRec(m_SCEV(), m_SCEV(Step))))
4410 return std::nullopt;
4411 if (SE.isKnownPositive(Step))
4412 return true;
4413 if (SE.isKnownNegative(Step))
4414 return false;
4415 return std::nullopt;
4416}
4417
4420 Loop &L) {
4421 ScalarEvolution &SE = *PSE.getSE();
4422 VPRegionBlock *VectorLoopRegion = Plan.getVectorLoopRegion();
4423
4424 // Helper lambda to check if the IV range excludes the sentinel value. Try
4425 // signed first, then unsigned. Return an excluded sentinel if found,
4426 // otherwise return std::nullopt.
4427 auto CheckSentinel = [&SE](const SCEV *IVSCEV,
4428 bool UseMax) -> std::optional<APSInt> {
4429 unsigned BW = IVSCEV->getType()->getScalarSizeInBits();
4430 for (bool Signed : {true, false}) {
4431 APSInt Sentinel = UseMax ? APSInt::getMinValue(BW, /*Unsigned=*/!Signed)
4432 : APSInt::getMaxValue(BW, /*Unsigned=*/!Signed);
4433
4434 ConstantRange IVRange =
4435 Signed ? SE.getSignedRange(IVSCEV) : SE.getUnsignedRange(IVSCEV);
4436 if (!IVRange.contains(Sentinel))
4437 return Sentinel;
4438 }
4439 return std::nullopt;
4440 };
4441
4442 VPValue *HeaderMask = VectorLoopRegion->getHeaderMask();
4443 for (VPRecipeBase &Phi :
4444 make_early_inc_range(VectorLoopRegion->getEntryBasicBlock()->phis())) {
4445 auto *PhiR = dyn_cast<VPReductionPHIRecipe>(&Phi);
4447 PhiR->getRecurrenceKind()))
4448 continue;
4449
4450 Type *PhiTy = PhiR->getScalarType();
4451 if (PhiTy->isPointerTy() || PhiTy->isFloatingPointTy())
4452 continue;
4453
4454 // If there's a header mask, the backedge select will not be the find-last
4455 // select.
4456 VPValue *BackedgeVal = PhiR->getBackedgeValue();
4457 auto *FindLastSelect = cast<VPSingleDefRecipe>(BackedgeVal);
4458 if (HeaderMask &&
4459 !match(BackedgeVal,
4460 m_Select(m_Specific(HeaderMask),
4461 m_VPSingleDefRecipe(FindLastSelect), m_Specific(PhiR))))
4462 continue;
4463
4464 // Get the find-last expression from the find-last select of the reduction
4465 // phi. The find-last select should be a select between the phi and the
4466 // find-last expression.
4467 VPValue *Cond, *FindLastExpression;
4468 if (!match(FindLastSelect, m_SelectLike(m_VPValue(Cond), m_Specific(PhiR),
4469 m_VPValue(FindLastExpression))) &&
4470 !match(FindLastSelect,
4471 m_SelectLike(m_VPValue(Cond), m_VPValue(FindLastExpression),
4472 m_Specific(PhiR))))
4473 continue;
4474
4475 // Check if FindLastExpression is a simple expression of a widened IV. If
4476 // so, we can track the underlying IV instead and sink the expression.
4477 auto *IVOfExpressionToSink = getExpressionIV(FindLastExpression);
4478 const SCEV *IVSCEV = vputils::getSCEVExprForVPValue(
4479 IVOfExpressionToSink ? IVOfExpressionToSink : FindLastExpression, PSE,
4480 &L);
4481 if (!match(IVSCEV, m_scev_AffineAddRec(m_SCEV(), m_SCEV()))) {
4482 assert(!match(vputils::getSCEVExprForVPValue(FindLastExpression, PSE, &L),
4484 "IVOfExpressionToSink not being an AddRec must imply "
4485 "FindLastExpression not being an AddRec.");
4486 continue;
4487 }
4488
4489 // Determine direction from the step of IVSCEV, if possible.
4490 std::optional<bool> StepDirection = getStepDirection(IVSCEV, SE);
4491 if (!StepDirection)
4492 continue;
4493
4494 bool UseMax = *StepDirection;
4495 std::optional<APSInt> SentinelVal = CheckSentinel(IVSCEV, UseMax);
4496 bool UseSigned = SentinelVal && SentinelVal->isSigned();
4497
4498 // Sinking an expression will disable epilogue vectorization. Only use it,
4499 // if FindLastExpression cannot be vectorized via a sentinel. Sinking may
4500 // also prevent vectorizing using a sentinel (e.g., if the expression is a
4501 // multiply or divide by large constant, respectively), which also makes
4502 // sinking undesirable.
4503 if (IVOfExpressionToSink) {
4504 const SCEV *FindLastExpressionSCEV =
4505 vputils::getSCEVExprForVPValue(FindLastExpression, PSE, &L);
4506 if (std::optional<bool> NewUseMax =
4507 getStepDirection(FindLastExpressionSCEV, SE)) {
4508 if (auto NewSentinel =
4509 CheckSentinel(FindLastExpressionSCEV, *NewUseMax)) {
4510 // The original expression already has a sentinel, so prefer not
4511 // sinking to keep epilogue vectorization possible.
4512 SentinelVal = *NewSentinel;
4513 UseSigned = NewSentinel->isSigned();
4514 UseMax = *NewUseMax;
4515 IVSCEV = FindLastExpressionSCEV;
4516 IVOfExpressionToSink = nullptr;
4517 }
4518 }
4519 }
4520
4521 // If no sentinel was found, fall back to a boolean AnyOf reduction to track
4522 // if the condition was ever true. Requires the IV to not wrap, otherwise we
4523 // cannot use min/max.
4524 if (!SentinelVal) {
4525 auto *AR = cast<SCEVAddRecExpr>(IVSCEV);
4526 if (AR->hasNoSignedWrap())
4527 UseSigned = true;
4528 else if (AR->hasNoUnsignedWrap())
4529 UseSigned = false;
4530 else
4531 continue;
4532 }
4533
4535 BackedgeVal,
4537
4538 VPValue *NewFindLastSelect = BackedgeVal;
4539 VPValue *SelectCond = Cond;
4540 if (!SentinelVal || IVOfExpressionToSink) {
4541 // When we need to create a new select, normalize the condition so that
4542 // PhiR is the last operand and include the header mask if needed.
4543 DebugLoc DL = FindLastSelect->getDefiningRecipe()->getDebugLoc();
4544 VPBuilder LoopBuilder(FindLastSelect->getDefiningRecipe());
4545 if (match(FindLastSelect,
4547 SelectCond = LoopBuilder.createNot(SelectCond);
4548
4549 // When tail folding, mask the condition with the header mask to prevent
4550 // propagating poison from inactive lanes in the last vector iteration.
4551 if (HeaderMask)
4552 SelectCond = LoopBuilder.createLogicalAnd(HeaderMask, SelectCond);
4553
4554 if (SelectCond != Cond || IVOfExpressionToSink) {
4555 NewFindLastSelect = LoopBuilder.createSelect(
4556 SelectCond,
4557 IVOfExpressionToSink ? IVOfExpressionToSink : FindLastExpression,
4558 PhiR, DL);
4559 }
4560 }
4561
4562 // Create the reduction result in the middle block using sentinel directly.
4563 RecurKind MinMaxKind =
4564 UseMax ? (UseSigned ? RecurKind::SMax : RecurKind::UMax)
4565 : (UseSigned ? RecurKind::SMin : RecurKind::UMin);
4566 VPIRFlags Flags(MinMaxKind, /*IsOrdered=*/false, /*IsInLoop=*/false,
4567 FastMathFlags());
4568 DebugLoc ExitDL = RdxResult->getDebugLoc();
4569 VPBuilder MiddleBuilder(RdxResult);
4570 VPValue *ReducedIV =
4572 NewFindLastSelect, Flags, ExitDL);
4573
4574 // If IVOfExpressionToSink is an expression to sink, sink it now.
4575 VPValue *VectorRegionExitingVal = ReducedIV;
4576 if (IVOfExpressionToSink)
4577 VectorRegionExitingVal =
4578 cloneBinOpForScalarIV(cast<VPWidenRecipe>(FindLastExpression),
4579 ReducedIV, IVOfExpressionToSink);
4580
4581 VPValue *NewRdxResult;
4582 VPValue *StartVPV = PhiR->getStartValue();
4583 if (SentinelVal) {
4584 // Sentinel-based approach: reduce IVs with min/max, compare against
4585 // sentinel to detect if condition was ever true, select accordingly.
4586 VPValue *Sentinel = Plan.getConstantInt(*SentinelVal);
4587 auto *Cmp = MiddleBuilder.createICmp(CmpInst::ICMP_NE, ReducedIV,
4588 Sentinel, ExitDL);
4589 NewRdxResult = MiddleBuilder.createSelect(Cmp, VectorRegionExitingVal,
4590 StartVPV, ExitDL);
4591 StartVPV = Sentinel;
4592 } else {
4593 // Introduce a boolean AnyOf reduction to track if the condition was ever
4594 // true in the loop. Use it to select the initial start value, if it was
4595 // never true.
4596 auto *AnyOfPhi = new VPReductionPHIRecipe(
4597 /*Phi=*/nullptr, RecurKind::Or, *Plan.getFalse(), *Plan.getFalse(),
4598 RdxUnordered{1}, {}, /*HasUsesOutsideReductionChain=*/false);
4599 AnyOfPhi->insertAfter(PhiR);
4600
4601 VPBuilder LoopBuilder(BackedgeVal->getDefiningRecipe());
4602 VPValue *OrVal = LoopBuilder.createOr(AnyOfPhi, SelectCond);
4603 AnyOfPhi->setOperand(1, OrVal);
4604
4605 NewRdxResult = MiddleBuilder.createAnyOfReduction(
4606 OrVal, VectorRegionExitingVal, StartVPV, ExitDL);
4607
4608 // Initialize the IV reduction phi with the neutral element, not the
4609 // original start value, to ensure correct min/max reduction results.
4610 StartVPV = Plan.getOrAddLiveIn(
4611 getRecurrenceIdentity(MinMaxKind, IVSCEV->getType(), {}));
4612 }
4613 RdxResult->replaceAllUsesWith(NewRdxResult);
4614 RdxResult->eraseFromParent();
4615
4616 auto *NewPhiR = new VPReductionPHIRecipe(
4617 cast<PHINode>(PhiR->getUnderlyingInstr()), RecurKind::FindIV, *StartVPV,
4618 *NewFindLastSelect, RdxUnordered{1}, {},
4619 PhiR->hasUsesOutsideReductionChain());
4620 NewPhiR->insertBefore(PhiR);
4621 PhiR->replaceAllUsesWith(NewPhiR);
4622 PhiR->eraseFromParent();
4623 }
4624}
4625
4626namespace {
4627
4628using ExtendKind = TTI::PartialReductionExtendKind;
4629struct ReductionExtend {
4630 Type *SrcType = nullptr;
4631 ExtendKind Kind = ExtendKind::PR_None;
4632};
4633
4634/// Describes the extends used to compute the extended reduction operand.
4635/// ExtendB is optional. If ExtendB is present, ExtendsUser is a binary
4636/// operation.
4637struct ExtendedReductionOperand {
4638 /// The recipe that consumes the extends.
4639 VPWidenRecipe *ExtendsUser = nullptr;
4640 /// Extend descriptions (inputs to getPartialReductionCost).
4641 ReductionExtend ExtendA, ExtendB;
4642};
4643
4644/// A chain of recipes that form a partial reduction. Matches either
4645/// reduction_bin_op (extended op, accumulator), or
4646/// reduction_bin_op (accumulator, extended op).
4647/// The possible forms of the "extended op" are listed in
4648/// matchExtendedReductionOperand.
4649struct VPPartialReductionChain {
4650 /// The top-level binary operation that forms the reduction to a scalar
4651 /// after the loop body.
4652 VPWidenRecipe *ReductionBinOp = nullptr;
4653 /// The user of the extends that is then reduced.
4654 ExtendedReductionOperand ExtendedOp;
4655 /// The recurrence kind for the entire partial reduction chain.
4656 /// This allows distinguishing between Sub and AddWithSub recurrences,
4657 /// when the ReductionBinOp is a Instruction::Sub.
4658 RecurKind RK;
4659 /// The index of the accumulator operand of ReductionBinOp. The extended op
4660 /// is `1 - AccumulatorOpIdx`.
4661 unsigned AccumulatorOpIdx;
4662 unsigned ScaleFactor;
4663 /// Optional blend to represent predication for the block that updates the
4664 /// reduction.
4665 VPBlendRecipe *Blend = nullptr;
4666};
4667
4668// Return the incoming index of the single-use value in the blend, which is
4669// expected to be the predicated reduction update.
4670static std::optional<unsigned>
4671getBlendReductionUpdateValueIdx(VPBlendRecipe *Blend) {
4672 assert(Blend && !Blend->isNormalized() &&
4673 Blend->getNumIncomingValues() == 2 &&
4674 "Expected a non-normalized blend with two incoming values");
4675 bool FirstIncomingHasOneUse = Blend->getIncomingValue(0)->hasOneUse();
4676
4677 // Only the update value should have one use (the blend). The previous
4678 // value should always have at least two uses, the blend and the reduction.
4679 if (FirstIncomingHasOneUse == Blend->getIncomingValue(1)->hasOneUse())
4680 return std::nullopt;
4681 return FirstIncomingHasOneUse ? 0 : 1;
4682}
4683
4684static VPSingleDefRecipe *
4685optimizeExtendsForPartialReduction(VPSingleDefRecipe *Op) {
4686 // reduce.add(mul(ext(A), C))
4687 // -> reduce.add(mul(ext(A), ext(trunc(C))))
4688 const APInt *Const;
4689 if (match(Op, m_Mul(m_ZExtOrSExt(m_VPValue()), m_APInt(Const)))) {
4690 auto *ExtA = cast<VPWidenCastRecipe>(Op->getOperand(0));
4691 Instruction::CastOps ExtOpc = ExtA->getOpcode();
4692 Type *NarrowTy = ExtA->getOperand(0)->getScalarType();
4693 if (!Op->hasOneUse() ||
4695 Const, NarrowTy, TTI::getPartialReductionExtendKind(ExtOpc)))
4696 return Op;
4697
4698 VPBuilder Builder(Op);
4699 auto *Trunc = Builder.createWidenCast(Instruction::CastOps::Trunc,
4700 Op->getOperand(1), NarrowTy);
4701 Type *WideTy = ExtA->getScalarType();
4702 Op->setOperand(1, Builder.createWidenCast(ExtOpc, Trunc, WideTy));
4703 return Op;
4704 }
4705
4706 // reduce.add(abs(sub(ext(A), ext(B))))
4707 // -> reduce.add(ext(absolute-difference(A, B)))
4708 VPValue *X, *Y;
4711 auto *Sub = Op->getOperand(0)->getDefiningRecipe();
4712 auto *Ext = cast<VPWidenCastRecipe>(Sub->getOperand(0));
4713 assert(Ext->getOpcode() ==
4714 cast<VPWidenCastRecipe>(Sub->getOperand(1))->getOpcode() &&
4715 "Expected both the LHS and RHS extends to be the same");
4716 bool IsSigned = Ext->getOpcode() == Instruction::SExt;
4717 VPBuilder Builder(Op);
4718 Type *SrcTy = X->getScalarType();
4719 auto *FreezeX = Builder.insert(new VPWidenRecipe(Instruction::Freeze, {X}));
4720 auto *FreezeY = Builder.insert(new VPWidenRecipe(Instruction::Freeze, {Y}));
4721 auto *Max = Builder.insert(
4722 new VPWidenIntrinsicRecipe(IsSigned ? Intrinsic::smax : Intrinsic::umax,
4723 {FreezeX, FreezeY}, SrcTy));
4724 auto *Min = Builder.insert(
4725 new VPWidenIntrinsicRecipe(IsSigned ? Intrinsic::smin : Intrinsic::umin,
4726 {FreezeX, FreezeY}, SrcTy));
4727 auto *AbsDiff = Builder.insert(
4728 new VPWidenRecipe(Instruction::Sub, {Max, Min},
4729 VPIRFlags::getDefaultFlags(Instruction::Sub)));
4730 return Builder.createWidenCast(Instruction::CastOps::ZExt, AbsDiff,
4731 Op->getScalarType());
4732 }
4733
4734 // reduce.add(ext(mul(ext(A), ext(B))))
4735 // -> reduce.add(mul(wider_ext(A), wider_ext(B)))
4736 // TODO: Support this optimization for float types.
4738 m_ZExtOrSExt(m_VPValue()))))) {
4739 auto *Ext = cast<VPWidenCastRecipe>(Op);
4740 auto *Mul = cast<VPWidenRecipe>(Ext->getOperand(0));
4741 auto *MulLHS = cast<VPWidenCastRecipe>(Mul->getOperand(0));
4742 auto *MulRHS = cast<VPWidenCastRecipe>(Mul->getOperand(1));
4743 if (!Mul->hasOneUse() ||
4744 (Ext->getOpcode() != MulLHS->getOpcode() && MulLHS != MulRHS) ||
4745 MulLHS->getOpcode() != MulRHS->getOpcode())
4746 return Op;
4747 VPBuilder Builder(Mul);
4748 auto *NewLHS = Builder.createWidenCast(
4749 MulLHS->getOpcode(), MulLHS->getOperand(0), Ext->getScalarType());
4750 auto *NewRHS = MulLHS == MulRHS
4751 ? NewLHS
4752 : Builder.createWidenCast(MulRHS->getOpcode(),
4753 MulRHS->getOperand(0),
4754 Ext->getScalarType());
4755 auto *NewMul = Mul->cloneWithOperands({NewLHS, NewRHS});
4756 Builder.insert(NewMul);
4757 Op->replaceAllUsesWith(NewMul);
4758 Op->eraseFromParent();
4759 Mul->eraseFromParent();
4760 return NewMul;
4761 }
4762
4763 return Op;
4764}
4765
4766static VPExpressionRecipe *
4767createPartialReductionExpression(VPReductionRecipe *Red) {
4768 VPValue *VecOp = Red->getVecOp();
4769
4770 // reduce.[f]add(ext(op))
4771 // -> VPExpressionRecipe(op, red)
4772 if (match(VecOp, m_WidenAnyExtend(m_VPValue())))
4773 return new VPExpressionRecipe(cast<VPWidenCastRecipe>(VecOp), Red);
4774
4775 // reduce.[f]add(neg(ext(op)))
4776 // -> VPExpressionRecipe(op, sub/neg, red)
4777 if (match(VecOp, m_AnyNeg(m_WidenAnyExtend(m_VPValue())))) {
4778 auto *Neg = cast<VPWidenRecipe>(VecOp);
4779 auto *Ext =
4780 cast<VPWidenCastRecipe>(Neg->getOperand(Neg->getNumOperands() - 1));
4781 return new VPExpressionRecipe(Ext, Neg, Red);
4782 }
4783
4784 // reduce.[f]add([f]mul(ext(a), ext(b)))
4785 // -> VPExpressionRecipe(a, b, mul, red)
4786 if (match(VecOp, m_FMul(m_FPExt(m_VPValue()), m_FPExt(m_VPValue()))) ||
4787 match(VecOp,
4789 auto *Mul = cast<VPWidenRecipe>(VecOp);
4790 auto *ExtA = cast<VPWidenCastRecipe>(Mul->getOperand(0));
4791 auto *ExtB = cast<VPWidenCastRecipe>(Mul->getOperand(1));
4792 return new VPExpressionRecipe(ExtA, ExtB, Mul, Red);
4793 }
4794
4795 // reduce.fadd(fneg(fmul(fpext(a), fpext(b))))
4796 // -> VPExpressionRecipe(a, b, fmul, fsub, red)
4797 if (match(VecOp,
4799 auto *FNeg = cast<VPWidenRecipe>(VecOp);
4800 auto *FMul = cast<VPWidenRecipe>(FNeg->getOperand(0));
4801 auto *ExtA = cast<VPWidenCastRecipe>(FMul->getOperand(0));
4802 auto *ExtB = cast<VPWidenCastRecipe>(FMul->getOperand(1));
4803 return new VPExpressionRecipe(ExtA, ExtB, FMul, FNeg, Red);
4804 }
4805
4806 // reduce.add(neg(mul(ext(a), ext(b))))
4807 // -> VPExpressionRecipe(a, b, mul, sub, red)
4809 m_ZExtOrSExt(m_VPValue()))))) {
4810 auto *Sub = cast<VPWidenRecipe>(VecOp);
4811 auto *Mul = cast<VPWidenRecipe>(Sub->getOperand(1));
4812 auto *ExtA = cast<VPWidenCastRecipe>(Mul->getOperand(0));
4813 auto *ExtB = cast<VPWidenCastRecipe>(Mul->getOperand(1));
4814 return new VPExpressionRecipe(ExtA, ExtB, Mul, Sub, Red);
4815 }
4816
4817 llvm_unreachable("Unsupported expression");
4818}
4819
4820// Helper to transform a partial reduction chain into a partial reduction
4821// recipe. Assumes profitability has been checked.
4822static void transformToPartialReduction(const VPPartialReductionChain &Chain,
4823 VPlan &Plan,
4824 VPReductionPHIRecipe *RdxPhi) {
4825 VPWidenRecipe *WidenRecipe = Chain.ReductionBinOp;
4826 assert(WidenRecipe->getNumOperands() == 2 && "Expected binary operation");
4827
4828 VPValue *Accumulator = WidenRecipe->getOperand(Chain.AccumulatorOpIdx);
4829 auto *ExtendedOp = cast<VPSingleDefRecipe>(
4830 WidenRecipe->getOperand(1 - Chain.AccumulatorOpIdx));
4831
4832 // FIXME: Do these transforms before invoking the cost-model.
4833 ExtendedOp = optimizeExtendsForPartialReduction(ExtendedOp);
4834
4835 // Sub-reductions can be implemented in two ways:
4836 // (1) negate the operand in the vector loop (the default way).
4837 // (2) subtract the reduced value from the init value in the middle block.
4838 // Both ways keep the reduction itself as an 'add' reduction.
4839 //
4840 // The ISD nodes for partial reductions don't support folding the
4841 // sub/negation into its operands because the following is not a valid
4842 // transformation:
4843 // sub(0, mul(ext(a), ext(b)))
4844 // -> mul(ext(a), ext(sub(0, b)))
4845 //
4846 // It's therefore better to choose option (2) such that the partial
4847 // reduction is always positive (starting at '0') and to do a final
4848 // subtract in the middle block.
4849 if ((WidenRecipe->getOpcode() == Instruction::Sub &&
4850 Chain.RK != RecurKind::Sub) ||
4851 (WidenRecipe->getOpcode() == Instruction::FSub &&
4852 Chain.RK != RecurKind::FSub)) {
4853 VPBuilder Builder(WidenRecipe);
4854 Type *ElemTy = ExtendedOp->getScalarType();
4855 VPWidenRecipe *NegRecipe;
4856 if (WidenRecipe->getOpcode() == Instruction::FSub) {
4857 NegRecipe =
4858 new VPWidenRecipe(Instruction::FNeg, {ExtendedOp},
4859 VPIRFlags::getDefaultFlags(Instruction::FNeg),
4861 } else {
4862 auto *Zero = Plan.getZero(ElemTy);
4863 NegRecipe =
4864 new VPWidenRecipe(Instruction::Sub, {Zero, ExtendedOp},
4865 VPIRFlags::getDefaultFlags(Instruction::Sub),
4867 }
4868 Builder.insert(NegRecipe);
4869 ExtendedOp = NegRecipe;
4870 }
4871
4872 // Check if WidenRecipe is the final result of the reduction. If so, look
4873 // through the Select recipe introduced by tail-folding, otherwise look
4874 // through any Blend recipe introduced by predication for the block.
4875 VPValue *ExitSearch =
4876 Chain.Blend ? cast<VPValue>(Chain.Blend) : cast<VPValue>(WidenRecipe);
4877
4878 VPValue *Cond = nullptr;
4880 findUserOf(ExitSearch, m_Select(m_VPValue(Cond), m_Specific(ExitSearch),
4881 m_Specific(RdxPhi))));
4882
4883 if (Chain.Blend) {
4884 std::optional<unsigned> BlendReductionIdx =
4885 getBlendReductionUpdateValueIdx(Chain.Blend);
4886 assert(BlendReductionIdx &&
4887 Chain.Blend->getIncomingValue(*BlendReductionIdx) == WidenRecipe &&
4888 "Expected blend to contain the reduction update");
4889 VPValue *BlendCond = Chain.Blend->getMask(*BlendReductionIdx);
4890 Cond = ExitValue ? VPBuilder(WidenRecipe)
4891 .createLogicalAnd(Cond, BlendCond,
4892 WidenRecipe->getDebugLoc())
4893 : BlendCond;
4894 }
4895
4896 // When folding the tail, the inactive lanes of the reduction update are
4897 // computed from values that do not correspond to any scalar iteration
4898 // and must not be accumulated.
4899 if (!Cond)
4901
4902 bool IsLastInChain = RdxPhi->getBackedgeValue() == WidenRecipe ||
4903 RdxPhi->getBackedgeValue() == ExitValue ||
4904 RdxPhi->getBackedgeValue() == Chain.Blend;
4905 assert((!ExitValue || IsLastInChain) &&
4906 "if we found ExitValue, it must match RdxPhi's backedge value");
4907
4908 Type *PhiType = RdxPhi->getScalarType();
4909 RecurKind RdxKind =
4911 auto *PartialRed = new VPReductionRecipe(
4912 RdxKind,
4913 RdxKind == RecurKind::FAdd ? WidenRecipe->getFastMathFlagsOrNone()
4914 : FastMathFlags(),
4915 WidenRecipe->getUnderlyingInstr(), Accumulator, ExtendedOp, Cond,
4916 RdxUnordered{/*VFScaleFactor=*/Chain.ScaleFactor});
4917 PartialRed->insertBefore(WidenRecipe);
4918
4919 if (ExitValue)
4920 ExitValue->replaceAllUsesWith(PartialRed);
4921 if (Chain.Blend)
4922 Chain.Blend->replaceAllUsesWith(PartialRed);
4923 WidenRecipe->replaceAllUsesWith(PartialRed);
4924
4925 // For cost-model purposes, fold this into a VPExpression.
4926 VPExpressionRecipe *E = createPartialReductionExpression(PartialRed);
4927 E->insertBefore(WidenRecipe);
4928 PartialRed->replaceAllUsesWith(E);
4929
4930 // We only need to update the PHI node once, which is when we find the
4931 // last reduction in the chain.
4932 if (!IsLastInChain)
4933 return;
4934
4935 // Scale the PHI and ReductionStartVector by the VFScaleFactor
4936 assert(RdxPhi->getVFScaleFactor() == 1 && "scale factor must not be set");
4937 RdxPhi->setVFScaleFactor(Chain.ScaleFactor);
4938
4939 auto *StartInst = cast<VPInstruction>(RdxPhi->getStartValue());
4940 assert(StartInst->getOpcode() == VPInstruction::ReductionStartVector);
4941 auto *NewScaleFactor = Plan.getConstantInt(32, Chain.ScaleFactor);
4942 StartInst->setOperand(2, NewScaleFactor);
4943
4944 // If this is the last value in a sub-reduction chain, then update the PHI
4945 // node to start at `0` and update the reduction-result to subtract from
4946 // the PHI's start value.
4947 if (Chain.RK != RecurKind::Sub && Chain.RK != RecurKind::FSub)
4948 return;
4949
4950 VPValue *OldStartValue = StartInst->getOperand(0);
4951 StartInst->setOperand(0, StartInst->getOperand(1));
4952
4953 // Replace reduction_result by 'sub (startval, reductionresult)'.
4955 assert(RdxResult && "Could not find reduction result");
4956
4957 VPBuilder Builder = VPBuilder::getToInsertAfter(RdxResult);
4958 unsigned SubOpc = Chain.RK == RecurKind::FSub ? Instruction::BinaryOps::FSub
4959 : Instruction::BinaryOps::Sub;
4960 VPInstruction *NewResult = Builder.createNaryOp(
4961 SubOpc, {OldStartValue, RdxResult}, VPIRFlags::getDefaultFlags(SubOpc),
4962 RdxPhi->getDebugLoc());
4963 RdxResult->replaceUsesWithIf(
4964 NewResult,
4965 [&NewResult](VPUser &U, unsigned Idx) { return &U != NewResult; });
4966}
4967
4968/// Returns the cost of a link in a partial-reduction chain for a given VF.
4969static InstructionCost
4970getPartialReductionLinkCost(VPCostContext &CostCtx,
4971 const VPPartialReductionChain &Link,
4972 ElementCount VF) {
4973 Type *RdxType = Link.ReductionBinOp->getScalarType();
4974 const ExtendedReductionOperand &ExtendedOp = Link.ExtendedOp;
4975 std::optional<unsigned> BinOpc = std::nullopt;
4976 // If ExtendB is not none, then the "ExtendsUser" is the binary operation.
4977 if (ExtendedOp.ExtendB.Kind != ExtendKind::PR_None)
4978 BinOpc = ExtendedOp.ExtendsUser->getOpcode();
4979
4980 std::optional<llvm::FastMathFlags> Flags;
4981 if (RdxType->isFloatingPointTy())
4982 Flags = Link.ReductionBinOp->getFastMathFlagsOrNone();
4983
4984 auto GetLinkOpcode = [&Link]() -> unsigned {
4985 switch (Link.RK) {
4986 case RecurKind::Sub:
4987 return Instruction::Add;
4988 case RecurKind::FSub:
4989 return Instruction::FAdd;
4990 default:
4991 return Link.ReductionBinOp->getOpcode();
4992 }
4993 };
4994
4995 return CostCtx.TTI.getPartialReductionCost(
4996 GetLinkOpcode(), ExtendedOp.ExtendA.SrcType, ExtendedOp.ExtendB.SrcType,
4997 RdxType, VF, ExtendedOp.ExtendA.Kind, ExtendedOp.ExtendB.Kind, BinOpc,
4998 CostCtx.CostKind, Flags);
4999}
5000
5001static ExtendKind getPartialReductionExtendKind(VPWidenCastRecipe *Cast) {
5003}
5004
5005/// Checks if \p Op (which is an operand of \p UpdateR) is an extended reduction
5006/// operand. This is an operand where the source of the value (e.g. a load) has
5007/// been extended (sext, zext, or fpext) before it is used in the reduction.
5008///
5009/// Possible forms matched by this function:
5010/// - UpdateR(PrevValue, ext(...))
5011/// - UpdateR(PrevValue, mul(ext(...), ext(...)))
5012/// - UpdateR(PrevValue, mul(ext(...), Constant))
5013/// - UpdateR(PrevValue, ext(mul(ext(...), ext(...))))
5014/// - UpdateR(PrevValue, ext(mul(ext(...), Constant)))
5015/// - UpdateR(PrevValue, abs(sub(ext(...), ext(...)))
5016///
5017/// Note: The second operand of UpdateR corresponds to \p Op in the examples.
5018static std::optional<ExtendedReductionOperand>
5019matchExtendedReductionOperand(VPWidenRecipe *UpdateR, VPValue *Op) {
5020 assert(is_contained(UpdateR->operands(), Op) &&
5021 "Op should be operand of UpdateR");
5022
5023 // Try matching an absolute difference operand of the form
5024 // `abs(sub(ext(A), ext(B)))`. This will be later transformed into
5025 // `ext(absolute-difference(A, B))`. This allows us to perform the absolute
5026 // difference on a wider type and get the extend for "free" from the partial
5027 // reduction.
5028 VPValue *X, *Y;
5029 if (Op->hasOneUse() &&
5033 auto *Abs = cast<VPWidenIntrinsicRecipe>(Op);
5034 auto *Sub = cast<VPWidenRecipe>(Abs->getOperand(0));
5035 auto *LHSExt = cast<VPWidenCastRecipe>(Sub->getOperand(0));
5036 auto *RHSExt = cast<VPWidenCastRecipe>(Sub->getOperand(1));
5037 Type *LHSInputType = X->getScalarType();
5038 Type *RHSInputType = Y->getScalarType();
5039 if (LHSInputType != RHSInputType ||
5040 LHSExt->getOpcode() != RHSExt->getOpcode())
5041 return std::nullopt;
5042 // Note: This is essentially the same as matching ext(...) as we will
5043 // rewrite this operand to ext(absolute-difference(A, B)).
5044 return ExtendedReductionOperand{
5045 Sub,
5046 /*ExtendA=*/{LHSInputType, getPartialReductionExtendKind(LHSExt)},
5047 /*ExtendB=*/{}};
5048 }
5049
5050 std::optional<TTI::PartialReductionExtendKind> OuterExtKind;
5052 auto *CastRecipe = cast<VPWidenCastRecipe>(Op);
5053 VPValue *CastSource = CastRecipe->getOperand(0);
5054 OuterExtKind = getPartialReductionExtendKind(CastRecipe);
5055 if (match(CastSource, m_Mul(m_VPValue(), m_VPValue())) ||
5056 match(CastSource, m_FMul(m_VPValue(), m_VPValue()))) {
5057 // Match: ext(mul(...))
5058 // Record the outer extend kind and set `Op` to the mul. We can then match
5059 // this as a binary operation. Note: We can optimize out the outer extend
5060 // by widening the inner extends to match it. See
5061 // optimizeExtendsForPartialReduction.
5062 Op = CastSource;
5063 } else {
5064 return ExtendedReductionOperand{
5065 UpdateR,
5066 /*ExtendA=*/{CastSource->getScalarType(), *OuterExtKind},
5067 /*ExtendB=*/{}};
5068 }
5069 }
5070
5071 if (!Op->hasOneUse())
5072 return std::nullopt;
5073
5075 if (!MulOp ||
5076 !is_contained({Instruction::Mul, Instruction::FMul}, MulOp->getOpcode()))
5077 return std::nullopt;
5078
5079 // The rest of the matching assumes `Op` is a (possibly extended) mul
5080 // operation.
5081
5082 VPValue *LHS = MulOp->getOperand(0);
5083 VPValue *RHS = MulOp->getOperand(1);
5084
5085 // The LHS of the operation must always be an extend.
5087 return std::nullopt;
5088
5089 auto *LHSCast = cast<VPWidenCastRecipe>(LHS);
5090 Type *LHSInputType = LHSCast->getOperand(0)->getScalarType();
5091 ExtendKind LHSExtendKind = getPartialReductionExtendKind(LHSCast);
5092
5093 // The RHS of the operation can be an extend or a constant integer.
5094 const APInt *RHSConst = nullptr;
5095 VPWidenCastRecipe *RHSCast = nullptr;
5097 RHSCast = cast<VPWidenCastRecipe>(RHS);
5098 else if (!match(RHS, m_APInt(RHSConst)) ||
5099 !canConstantBeExtended(RHSConst, LHSInputType, LHSExtendKind))
5100 return std::nullopt;
5101
5102 // The outer extend kind must match the inner extends for folding.
5103 for (VPWidenCastRecipe *Cast : {LHSCast, RHSCast})
5104 if (Cast && OuterExtKind &&
5105 getPartialReductionExtendKind(Cast) != OuterExtKind)
5106 return std::nullopt;
5107
5108 Type *RHSInputType = LHSInputType;
5109 ExtendKind RHSExtendKind = LHSExtendKind;
5110 if (RHSCast) {
5111 RHSInputType = RHSCast->getOperand(0)->getScalarType();
5112 RHSExtendKind = getPartialReductionExtendKind(RHSCast);
5113 }
5114
5115 return ExtendedReductionOperand{
5116 MulOp, {LHSInputType, LHSExtendKind}, {RHSInputType, RHSExtendKind}};
5117}
5118
5119/// Examines each operation in the reduction chain corresponding to \p RedPhiR,
5120/// and determines if the target can use a cheaper operation with a wider
5121/// per-iteration input VF and narrower PHI VF. If successful, returns the chain
5122/// of operations in the reduction.
5123static std::optional<SmallVector<VPPartialReductionChain>>
5124getScaledReductions(VPReductionPHIRecipe *RedPhiR) {
5125 // Get the backedge value from the reduction PHI and find the
5126 // ComputeReductionResult that uses it (directly or through a select for
5127 // predicated reductions).
5128 auto *RdxResult = vputils::findComputeReductionResult(RedPhiR);
5129 if (!RdxResult)
5130 return std::nullopt;
5131 VPValue *ExitValue = RdxResult->getOperand(0);
5132 match(ExitValue, m_Select(m_VPValue(), m_VPValue(ExitValue), m_VPValue()));
5133
5135 RecurKind RK = RedPhiR->getRecurrenceKind();
5136 Type *PhiType = RedPhiR->getScalarType();
5137 TypeSize PHISize = PhiType->getPrimitiveSizeInBits();
5138
5139 // Work backwards from the ExitValue examining each reduction operation.
5140 VPValue *CurrentValue = ExitValue;
5141 while (CurrentValue != RedPhiR) {
5142 VPBlendRecipe *Blend = dyn_cast<VPBlendRecipe>(CurrentValue);
5143 std::optional<unsigned> BlendReductionIdx;
5144 if (Blend) {
5145 assert(!Blend->isNormalized() && "Expect Blend not to be normalized.");
5146 if (Blend->getNumIncomingValues() != 2)
5147 return std::nullopt;
5148
5149 BlendReductionIdx = getBlendReductionUpdateValueIdx(Blend);
5150 if (!BlendReductionIdx)
5151 return std::nullopt;
5152
5153 CurrentValue = Blend->getIncomingValue(*BlendReductionIdx);
5154 }
5155
5156 auto *UpdateR = dyn_cast<VPWidenRecipe>(CurrentValue);
5157 if (!UpdateR || !Instruction::isBinaryOp(UpdateR->getOpcode()))
5158 return std::nullopt;
5159
5160 VPValue *Op = UpdateR->getOperand(1);
5161 VPValue *PrevValue = UpdateR->getOperand(0);
5162
5163 // Find the extended operand. The other operand (PrevValue) is the next link
5164 // in the reduction chain.
5165 std::optional<ExtendedReductionOperand> ExtendedOp =
5166 matchExtendedReductionOperand(UpdateR, Op);
5167 if (!ExtendedOp) {
5168 ExtendedOp = matchExtendedReductionOperand(UpdateR, PrevValue);
5169 if (!ExtendedOp)
5170 return std::nullopt;
5171 std::swap(Op, PrevValue);
5172 }
5173
5174 // Look for VPBlend(reduce(PrevValue, Op), PrevValue), where
5175 // reduce is equal to CurrentValue. This can be lowered as
5176 // a conditional reduction by hoisting the select to the inputs.
5177 if (Blend && Blend->getIncomingValue(1 - *BlendReductionIdx) != PrevValue)
5178 return std::nullopt;
5179
5180 Type *ExtSrcType = ExtendedOp->ExtendA.SrcType;
5181 TypeSize ExtSrcSize = ExtSrcType->getPrimitiveSizeInBits();
5182 if (!PHISize.hasKnownScalarFactor(ExtSrcSize))
5183 return std::nullopt;
5184
5185 VPPartialReductionChain Link(
5186 {UpdateR, *ExtendedOp, RK,
5187 PrevValue == UpdateR->getOperand(0) ? 0U : 1U,
5188 static_cast<unsigned>(PHISize.getKnownScalarFactor(ExtSrcSize)),
5189 Blend});
5190 Chain.push_back(Link);
5191 CurrentValue = PrevValue;
5192 }
5193
5194 // The chain links were collected by traversing backwards from the exit value.
5195 // Reverse the chains so they are in program order.
5196 std::reverse(Chain.begin(), Chain.end());
5197 return Chain;
5198}
5199} // namespace
5200
5202 VPCostContext &CostCtx,
5203 VFRange &Range) {
5204 // Find all possible valid partial reductions, grouping chains by their PHI.
5205 // This grouping allows invalidating the whole chain, if any link is not a
5206 // valid partial reduction.
5208 ChainsByPhi;
5209 VPBasicBlock *HeaderVPBB = Plan.getVectorLoopRegion()->getEntryBasicBlock();
5210 for (VPRecipeBase &R : HeaderVPBB->phis()) {
5211 auto *RedPhiR = dyn_cast<VPReductionPHIRecipe>(&R);
5212 if (!RedPhiR)
5213 continue;
5214
5215 if (auto Chains = getScaledReductions(RedPhiR))
5216 ChainsByPhi.try_emplace(RedPhiR, std::move(*Chains));
5217 }
5218
5219 if (ChainsByPhi.empty())
5220 return;
5221
5222 // Build set of partial reduction operations and blends for user validation
5223 // and a map of reduction bin ops to their scale factors for scale validation.
5224 SmallPtrSet<VPRecipeBase *, 4> PartialReductionOps;
5225 SmallPtrSet<VPBlendRecipe *, 4> PartialReductionBlends;
5226 DenseMap<VPSingleDefRecipe *, unsigned> ScaledReductionMap;
5227 for (const auto &[_, Chains] : ChainsByPhi)
5228 for (const VPPartialReductionChain &Chain : Chains) {
5229 PartialReductionOps.insert(Chain.ExtendedOp.ExtendsUser);
5230 if (Chain.Blend)
5231 PartialReductionBlends.insert(Chain.Blend);
5232 ScaledReductionMap[Chain.ReductionBinOp] = Chain.ScaleFactor;
5233 }
5234
5235 // A partial reduction is invalid if any of its extends are used by
5236 // something that isn't another partial reduction. This is because the
5237 // extends are intended to be lowered along with the reduction itself.
5238 auto ExtendUsersValid = [&](VPValue *Ext) {
5239 return !isa<VPWidenCastRecipe>(Ext) || all_of(Ext->users(), [&](VPUser *U) {
5240 return PartialReductionOps.contains(cast<VPRecipeBase>(U));
5241 });
5242 };
5243
5244 auto IsProfitablePartialReductionChainForVF =
5245 [&](ArrayRef<VPPartialReductionChain> Chain, ElementCount VF) -> bool {
5246 InstructionCost PartialCost = 0, RegularCost = 0;
5247
5248 // The chain is a profitable partial reduction chain if the cost of handling
5249 // the entire chain is cheaper when using partial reductions than when
5250 // handling the entire chain using regular reductions.
5251 for (const VPPartialReductionChain &Link : Chain) {
5252 const ExtendedReductionOperand &ExtendedOp = Link.ExtendedOp;
5253 InstructionCost LinkCost = getPartialReductionLinkCost(CostCtx, Link, VF);
5254 if (!LinkCost.isValid())
5255 return false;
5256
5257 PartialCost += LinkCost;
5258 RegularCost += Link.ReductionBinOp->computeCost(VF, CostCtx);
5259 // If ExtendB is not none, then the "ExtendsUser" is the binary operation.
5260 if (ExtendedOp.ExtendB.Kind != ExtendKind::PR_None)
5261 RegularCost += ExtendedOp.ExtendsUser->computeCost(VF, CostCtx);
5262 for (VPValue *Op : ExtendedOp.ExtendsUser->operands())
5263 if (auto *Extend = dyn_cast<VPWidenCastRecipe>(Op))
5264 RegularCost += Extend->computeCost(VF, CostCtx);
5265 }
5266 return PartialCost.isValid() && PartialCost < RegularCost;
5267 };
5268
5269 // Validate chains: check that extends are only used by partial reductions,
5270 // and that reduction bin ops are only used by other partial reductions with
5271 // matching scale factors, are outside the loop region or the select
5272 // introduced by tail-folding. Otherwise we would create users of scaled
5273 // reductions where the types of the other operands don't match.
5274 for (auto &[RedPhiR, Chains] : ChainsByPhi) {
5275 for (const VPPartialReductionChain &Chain : Chains) {
5276 if (!all_of(Chain.ExtendedOp.ExtendsUser->operands(), ExtendUsersValid)) {
5277 Chains.clear();
5278 break;
5279 }
5280 auto UseIsValid = [&, RedPhiR = RedPhiR](VPUser *U) {
5281 if (auto *PhiR = dyn_cast<VPReductionPHIRecipe>(U))
5282 return PhiR == RedPhiR;
5283 auto *R = cast<VPSingleDefRecipe>(U);
5284
5285 if (auto *Blend = dyn_cast<VPBlendRecipe>(R))
5286 return Blend == Chain.Blend || PartialReductionBlends.contains(Blend);
5287
5288 return Chain.ScaleFactor == ScaledReductionMap.lookup_or(R, 0) ||
5290 m_Specific(Chain.ReductionBinOp))) ||
5291 match(R, m_Select(m_VPValue(), m_Specific(Chain.ReductionBinOp),
5292 m_Specific(RedPhiR)));
5293 };
5294 if (!all_of(Chain.ReductionBinOp->users(), UseIsValid)) {
5295 Chains.clear();
5296 break;
5297 }
5298
5299 // Check if the compute-reduction-result is used by a sunk store.
5300 // TODO: Also form partial reductions in those cases.
5301 if (auto *RdxResult = vputils::findComputeReductionResult(RedPhiR)) {
5302 if (any_of(RdxResult->users(), [](VPUser *U) {
5303 auto *RepR = dyn_cast<VPReplicateRecipe>(U);
5304 return RepR && RepR->getOpcode() == Instruction::Store;
5305 })) {
5306 Chains.clear();
5307 break;
5308 }
5309 }
5310 }
5311
5312 // Clear the chain if it is not profitable.
5314 [&, &Chains = Chains](ElementCount VF) {
5315 return IsProfitablePartialReductionChainForVF(Chains, VF);
5316 },
5317 Range))
5318 Chains.clear();
5319 }
5320
5321 for (auto &[Phi, Chains] : ChainsByPhi)
5322 for (const VPPartialReductionChain &Chain : Chains)
5323 transformToPartialReduction(Chain, Plan, Phi);
5324}
5325
5327 VPRecipeBuilder &RecipeBuilder,
5328 VPCostContext &CostCtx) {
5329 // Collect all loads/stores first. We will start with ones having simpler
5330 // decisions followed by more complex ones that are potentially
5331 // guided/dependent on the simpler ones.
5333 for (VPBasicBlock *VPBB :
5336 for (VPRecipeBase &R : *VPBB) {
5337 auto *VPI = dyn_cast<VPInstruction>(&R);
5338 if (VPI && VPI->getUnderlyingValue() &&
5339 is_contained({Instruction::Load, Instruction::Store},
5340 VPI->getOpcode()))
5341 MemOps.push_back(VPI);
5342 }
5343 }
5344
5345 // Few helpers to process different kinds of memory operations.
5346
5347 // To be used as argument to `VPlanTransforms::runPass` which explicitly
5348 // specified pass name, hence `VPlan &` parameter.
5349 auto ProcessSubset = [&](VPlan &, auto ProcessVPInst) {
5350 SmallVector<VPInstruction *> RemainingMemOps;
5351 for (VPInstruction *VPI : MemOps) {
5352 if (!ProcessVPInst(VPI))
5353 RemainingMemOps.push_back(VPI);
5354 }
5355
5356 MemOps.clear();
5357 std::swap(MemOps, RemainingMemOps);
5358 };
5359
5360 auto ReplaceWith = [&](VPInstruction *VPI, VPRecipeBase *New) {
5361 assert(New->getParent() && "New recipe must have been inserted");
5362 if (VPI->getOpcode() == Instruction::Load)
5363 VPI->replaceAllUsesWith(New->getVPSingleValue());
5364 VPI->eraseFromParent();
5365
5366 // VPI has been processed.
5367 return true;
5368 };
5369
5370 auto Scalarize = [&](VPInstruction *VPI) {
5371 return ReplaceWith(VPI, VPBuilder(VPI).insert(
5372 RecipeBuilder.handleReplication(VPI, Range)));
5373 };
5374
5375 VPBasicBlock *MiddleVPBB = Plan.getMiddleBlock();
5376 VPBuilder FinalRedStoresBuilder(MiddleVPBB, MiddleVPBB->getFirstNonPhi());
5378 "lowerMemoryIdioms", ProcessSubset, Plan, [&](VPInstruction *VPI) {
5379 if (RecipeBuilder.replaceWithFinalIfReductionStore(
5380 VPI, FinalRedStoresBuilder))
5381 return true;
5382
5383 // Filter out scalar VPlan for the remaining idioms.
5385 [](ElementCount VF) { return VF.isScalar(); }, Range))
5386 return false;
5387
5388 if (VPHistogramRecipe *Histogram = RecipeBuilder.widenIfHistogram(VPI))
5389 return ReplaceWith(VPI, VPBuilder(VPI).insert(Histogram));
5390
5391 return false;
5392 });
5393
5394 // Filter out scalar VPlan for the remaining memory operations.
5396 [](ElementCount VF) { return VF.isScalar(); }, Range))
5397 return;
5398
5399 // If the instruction's allocated size doesn't equal it's type size, it
5400 // requires padding and will be scalarized.
5402 "scalarizeMemOpsWithIrregularTypes", ProcessSubset, Plan,
5403 [&](VPInstruction *VPI) {
5405 if (hasIrregularType(getLoadStoreType(I), I->getDataLayout()))
5406 return Scalarize(VPI);
5407
5408 return false;
5409 });
5410
5411 if (!RecipeBuilder.prefersVectorizedAddressing()) {
5413 "makeVPlanMemOpDecision", ProcessSubset, Plan, [&](VPInstruction *VPI) {
5415 bool IsLoad = VPI->getOpcode() == Instruction::Load;
5416 if (RecipeBuilder.isPredicatedInst(I) || !IsLoad ||
5418 return false;
5419
5420 // Scalarize loads used as addresses, matching the legacy CM. The load
5421 // is single-scalar if the pointer is loop-invariant, otherwise it is
5422 // replicated per-lane. No mask is needed as the load is not
5423 // predicated.
5424 VPValue *Ptr = VPI->getOperand(0);
5425 const SCEV *PtrSCEV =
5426 vputils::getSCEVExprForVPValue(Ptr, CostCtx.PSE, CostCtx.L);
5427 bool IsSingleScalarLoad =
5428 !isa<SCEVCouldNotCompute>(PtrSCEV) &&
5429 CostCtx.PSE.getSE()->isLoopInvariant(PtrSCEV, CostCtx.L);
5430
5431 ReplaceWith(VPI,
5432 VPBuilder(VPI).insert(new VPReplicateRecipe(
5433 I, Ptr, /*IsSingleScalar=*/IsSingleScalarLoad,
5434 /*Mask=*/nullptr, *VPI, *VPI, VPI->getDebugLoc())));
5435 return true;
5436 });
5437 }
5438
5439 // Widen unit-stride consecutive accesses, matching the legacy CM. Both
5440 // forward (stride +1) and reverse (stride -1) accesses are handled.
5442 "widenConsecutiveMemOps", ProcessSubset, Plan, [&](VPInstruction *VPI) {
5444 bool IsLoad = VPI->getOpcode() == Instruction::Load;
5445 VPValue *Ptr = VPI->getOperand(!IsLoad);
5446 Type *ScalarTy =
5447 IsLoad ? VPI->getScalarType() : VPI->getOperand(0)->getScalarType();
5448 std::optional<int64_t> Stride =
5449 getConstantStride(Ptr, ScalarTy, CostCtx.PSE, CostCtx.L);
5450 if (Stride != 1 && Stride != -1)
5451 return false;
5452 bool Reverse = Stride == -1;
5453
5454 // A predicated access can only be widened (rather than scalarized) if
5455 // the target supports a masked load/store for it.
5456 // TODO: Determine if a load/store needs predication directly in VPlan.
5457 bool IsPredicated = RecipeBuilder.isPredicatedInst(I);
5458 if (IsPredicated && !CostCtx.Config.isLegalMaskedLoadOrStore(
5459 IsLoad, ScalarTy, getLoadStoreAlignment(I),
5461 return false;
5462
5463 VPBuilder Builder(VPI);
5464 VPSingleDefRecipe *VectorPtr = Builder.createConsecutiveVectorPointer(
5465 Ptr, ScalarTy, Reverse, VPI->getDebugLoc());
5466
5467 VPValue *Mask = IsPredicated ? VPI->getMask() : nullptr;
5468 // Reverse the mask so it matches the reversed access order.
5469 if (Reverse && Mask)
5470 Mask = Builder.createNaryOp(VPInstruction::Reverse, Mask,
5471 VPI->getDebugLoc());
5472
5473 if (IsLoad) {
5474 VPSingleDefRecipe *Load = Builder.createWidenLoad(
5475 *cast<LoadInst>(I), VectorPtr, Mask,
5476 /*Consecutive=*/true, *VPI, VPI->getDebugLoc());
5477 // Reverse the loaded values back into program order.
5478 if (Reverse)
5479 Load = Builder.createNaryOp(VPInstruction::Reverse, Load,
5480 VPI->getDebugLoc());
5481 return ReplaceWith(VPI, Load);
5482 }
5483
5484 VPValue *StoredVal = VPI->getOperand(0);
5485 if (Reverse)
5486 // Reverse the stored values so they are written in descending order.
5487 StoredVal = Builder.createNaryOp(VPInstruction::Reverse, StoredVal,
5488 VPI->getDebugLoc());
5489
5490 auto *StoreR = Builder.createWidenStore(
5491 *cast<StoreInst>(I), VectorPtr, StoredVal, Mask,
5492 /*Consecutive=*/true, *VPI, VPI->getDebugLoc());
5493 return ReplaceWith(VPI, StoreR);
5494 });
5495
5496 VPlanTransforms::runPass("delegateMemOpWideningToLegacyCM", ProcessSubset,
5497 Plan, [&](VPInstruction *VPI) {
5498 if (VPRecipeBase *Recipe =
5499 RecipeBuilder.tryToWidenMemory(VPI, Range))
5500 return ReplaceWith(VPI, Recipe);
5501
5502 return Scalarize(VPI);
5503 });
5504}
5505
5508 [&](ElementCount VF) { return VF.isScalar(); }, Range))
5509 return;
5510
5512 Plan.getEntry());
5514 for (VPRecipeBase &R : make_early_inc_range(reverse(*VPBB))) {
5515 auto *VPI = dyn_cast<VPInstruction>(&R);
5516 if (!VPI)
5517 continue;
5518
5519 auto *I = cast_or_null<Instruction>(VPI->getUnderlyingValue());
5520 // Wouldn't be able to create a `VPReplicateRecipe` anyway.
5521 if (!I)
5522 continue;
5523
5524 // If executing other lanes produces side-effects we can't avoid them.
5525 if (VPI->mayHaveSideEffects())
5526 continue;
5527
5528 // We want to drop the mask operand, verify we can safely do that.
5529 if (VPI->isMasked() && !VPI->isSafeToSpeculativelyExecute())
5530 continue;
5531
5532 // Avoid rewriting IV increment as that interferes with
5533 // `removeRedundantCanonicalIVs`.
5534 if (VPI->getOpcode() == Instruction::Add &&
5536 continue;
5537
5538 // Other lanes are needed - can't drop them.
5540 continue;
5541
5542 auto *Recipe = VPBuilder::createSingleScalarOp(
5543 VPI->getOpcode(), VPI->operandsWithoutMask(), /*Mask=*/nullptr, *VPI,
5544 *VPI, VPI->getDebugLoc(), I);
5545 Recipe->insertBefore(VPI);
5546 VPI->replaceAllUsesWith(Recipe);
5547 VPI->eraseFromParent();
5548 }
5549 }
5550}
5551
5552/// Returns true if \p Info's parameter kinds are compatible with \p Args.
5553static bool areVFParamsOk(const VFInfo &Info, ArrayRef<VPValue *> Args,
5554 PredicatedScalarEvolution &PSE, const Loop *L) {
5555 ScalarEvolution *SE = PSE.getSE();
5556 return all_of(Info.Shape.Parameters, [&](VFParameter Param) {
5557 switch (Param.ParamKind) {
5558 case VFParamKind::Vector:
5559 case VFParamKind::GlobalPredicate:
5560 return true;
5561 case VFParamKind::OMP_Uniform:
5562 return SE->isSCEVable(Args[Param.ParamPos]->getScalarType()) &&
5563 SE->isLoopInvariant(
5564 vputils::getSCEVExprForVPValue(Args[Param.ParamPos], PSE, L),
5565 L);
5566 case VFParamKind::OMP_Linear:
5567 return match(vputils::getSCEVExprForVPValue(Args[Param.ParamPos], PSE, L),
5568 m_scev_AffineAddRec(
5569 m_SCEV(), m_scev_SpecificSInt(Param.LinearStepOrPos),
5570 m_SpecificLoop(L)));
5571 default:
5572 return false;
5573 }
5574 });
5575}
5576
5577/// Find a vector variant of \p CI for \p VF, respecting \p MaskRequired.
5578/// Returns the variant function, or nullptr. Masked variants are assumed to
5579/// take the mask as a trailing parameter.
5581 ElementCount VF, bool MaskRequired,
5583 const Loop *L) {
5584 if (CI->isNoBuiltin())
5585 return nullptr;
5586 auto Mappings = VFDatabase::getMappings(*CI);
5587 const auto *It = find_if(Mappings, [&](const VFInfo &Info) {
5588 return Info.Shape.VF == VF && (!MaskRequired || Info.isMasked()) &&
5589 areVFParamsOk(Info, Args, PSE, L);
5590 });
5591 if (It == Mappings.end())
5592 return nullptr;
5593 return CI->getModule()->getFunction(It->VectorName);
5594}
5595
5596namespace {
5597/// The outcome of choosing how to widen a call at a given VF.
5598struct CallWideningDecision {
5599 enum class KindTy { Scalarize, Intrinsic, VectorVariant };
5600 CallWideningDecision(KindTy Kind, Function *Variant = nullptr)
5601 : Kind(Kind), Variant(Variant) {}
5602 KindTy Kind;
5603
5604 /// Set when Kind == VectorVariant.
5606
5607 bool operator==(const CallWideningDecision &Other) const {
5608 return Kind == Other.Kind && Variant == Other.Variant;
5609 }
5610};
5611} // namespace
5612
5613/// Pick the cheapest widening for the call \p VPI at \p VF among scalarization,
5614/// vector intrinsic, and vector library variant.
5615static CallWideningDecision decideCallWidening(VPInstruction &VPI,
5617 ElementCount VF,
5618 VPCostContext &CostCtx) {
5619 auto *CI = cast<CallInst>(VPI.getUnderlyingInstr());
5620
5621 // Scalar VFs and calls forced or known to scalarize always replicate.
5622 if (VF.isScalar() || CostCtx.willBeScalarized(CI, VF))
5623 return CallWideningDecision::KindTy::Scalarize;
5624
5625 auto *CalledFn = cast<Function>(
5627 Type *ResultTy = VPI.getScalarType();
5629 bool MaskRequired = CostCtx.isMaskRequired(CI);
5630
5631 // Pseudo intrinsics (assume, lifetime, ...) are always scalarized.
5633 return CallWideningDecision::KindTy::Scalarize;
5634
5635 InstructionCost ScalarCost =
5636 VPReplicateRecipe::computeCallCost(CalledFn, ResultTy, Ops,
5637 /*IsSingleScalar=*/false, VF, CostCtx);
5638
5639 Function *VecFunc =
5640 findVectorVariant(CI, Ops, VF, MaskRequired, CostCtx.PSE, CostCtx.L);
5642 if (VecFunc)
5643 VecCallCost = VPWidenCallRecipe::computeCallCost(VecFunc, CostCtx);
5644
5645 // Prefer the intrinsic if it is at least as cheap as scalarizing and any
5646 // available vector variant.
5647 if (ID) {
5649 VPWidenIntrinsicRecipe::computeCallCost(ID, Ops, VPI, VF, CostCtx);
5650 if (IntrinsicCost.isValid() && ScalarCost >= IntrinsicCost &&
5651 (!VecFunc || VecCallCost >= IntrinsicCost))
5652 return CallWideningDecision::KindTy::Intrinsic;
5653 }
5654
5655 // Otherwise, use a vector library variant when it beats scalarizing.
5656 if (VecFunc && ScalarCost >= VecCallCost)
5657 return {CallWideningDecision::KindTy::VectorVariant, VecFunc};
5658
5659 return CallWideningDecision::KindTy::Scalarize;
5660}
5661
5663 VPRecipeBuilder &RecipeBuilder,
5664 VPCostContext &CostCtx) {
5667 for (VPRecipeBase &R : make_early_inc_range(*VPBB)) {
5668 auto *VPI = dyn_cast<VPInstruction>(&R);
5669 if (!VPI || !VPI->getUnderlyingValue() ||
5670 VPI->getOpcode() != Instruction::Call)
5671 continue;
5672
5673 auto *CI = cast<CallInst>(VPI->getUnderlyingInstr());
5674 SmallVector<VPValue *, 4> Ops(VPI->op_begin(),
5675 VPI->op_begin() + CI->arg_size());
5676
5677 CallWideningDecision Decision =
5678 decideCallWidening(*VPI, Ops, Range.Start, CostCtx);
5680 [&](ElementCount VF) {
5681 return Decision == decideCallWidening(*VPI, Ops, VF, CostCtx);
5682 },
5683 Range);
5684
5685 VPSingleDefRecipe *Replacement = nullptr;
5686 switch (Decision.Kind) {
5687 case CallWideningDecision::KindTy::Intrinsic: {
5689 Type *ResultTy = VPI->getScalarType();
5690 Replacement = new VPWidenIntrinsicRecipe(*CI, ID, Ops, ResultTy, *VPI,
5691 *VPI, VPI->getDebugLoc());
5692 break;
5693 }
5694 case CallWideningDecision::KindTy::VectorVariant: {
5695 // Masked variants take the mask as a trailing parameter, so they have
5696 // one more parameter than the original call's arguments.
5697 if (Decision.Variant->arg_size() > Ops.size()) {
5698 VPValue *Mask = VPI->isMasked() ? VPI->getMask() : Plan.getTrue();
5699 Ops.push_back(Mask);
5700 }
5701 Ops.push_back(VPI->getOperand(VPI->getNumOperandsWithoutMask() - 1));
5702 Replacement = new VPWidenCallRecipe(CI, Decision.Variant, Ops, *VPI,
5703 *VPI, VPI->getDebugLoc());
5704 break;
5705 }
5706 case CallWideningDecision::KindTy::Scalarize:
5707 Replacement = RecipeBuilder.handleReplication(VPI, Range);
5708 break;
5709 }
5710
5711 Replacement->insertBefore(VPI);
5712 VPI->replaceAllUsesWith(Replacement);
5713 VPI->eraseFromParent();
5714 }
5715 }
5716}
5717
5720 Loop &L, VPCostContext &Ctx,
5721 VFRange &Range) {
5722 if (Plan.hasScalarVFOnly())
5723 return;
5724
5725 VPRegionBlock *VectorLoop = Plan.getVectorLoopRegion();
5726 VPValue *I32VF = nullptr;
5728 vp_depth_first_shallow(VectorLoop->getEntry()))) {
5729 for (VPRecipeBase &R : make_early_inc_range(*VPBB)) {
5730 auto *MemR = dyn_cast<VPWidenMemoryRecipe>(&R);
5731 // TODO: Transform reverse access into strided access with -1 stride.
5732 // TODO: Transform gather/scatter with uniform address into strided access
5733 // with 0 stride.
5734 // TODO: Transform interleave access into multiple strided accesses.
5735 if (!MemR || MemR->isConsecutive())
5736 continue;
5737
5738 VPValue *Ptr = MemR->getAddr();
5739 // Check if this is a strided access by analyzing the address SCEV for an
5740 // affine addRec.
5741 const SCEV *PtrSCEV = vputils::getSCEVExprForVPValue(Ptr, PSE, &L);
5742 const SCEV *Start;
5743 const SCEVConstant *Step;
5744 // TODO: Support non-constant loop invariant stride.
5745 if (!match(PtrSCEV,
5747 m_SpecificLoop(&L))))
5748 continue;
5749
5750 VPValue *StoredValue = nullptr;
5751 Type *DataTy;
5752 Intrinsic::ID IntrinID;
5753 if (auto *StoreR = dyn_cast<VPWidenStoreRecipe>(&R)) {
5754 StoredValue = StoreR->getStoredValue();
5755 DataTy = StoredValue->getScalarType();
5756 IntrinID = Intrinsic::experimental_vp_strided_store;
5757 } else {
5758 auto *LoadR = cast<VPWidenLoadRecipe>(&R);
5759 DataTy = LoadR->getScalarType();
5760 IntrinID = Intrinsic::experimental_vp_strided_load;
5761 }
5762
5763 Align Alignment = MemR->getAlign();
5764 auto IsProfitable = [&](ElementCount VF) {
5765 Type *VectorTy = toVectorTy(DataTy, VF);
5766 if (!Ctx.TTI.isLegalStridedLoadStore(VectorTy, Alignment))
5767 return false;
5768 const InstructionCost CurrentCost = MemR->computeCost(VF, Ctx);
5769 const InstructionCost StridedLoadStoreCost =
5771 IntrinID, VectorTy, MemR->isMasked(), Alignment, Ctx);
5772 return StridedLoadStoreCost < CurrentCost;
5773 };
5774
5776 Range))
5777 continue;
5778
5779 // Invalidate the legacy widening decision so the cost of replaced load is
5780 // not counted during precomputeCosts.
5781 // TODO: Remove once the legacy exit cost computation is retired.
5782 for (ElementCount VF : Range)
5783 Ctx.invalidateWideningDecision(&MemR->getIngredient(), VF);
5784
5785 // Get VF as i32 for the vector length operand.
5786 if (!I32VF) {
5787 VPBuilder Builder(Plan.getVectorPreheader());
5788 I32VF = Builder.createScalarZExtOrTrunc(
5789 &Plan.getVF(), Type::getInt32Ty(Plan.getContext()),
5791 }
5792
5793 VPBuilder Builder(&R);
5794 // Create the base pointer of strided access.
5795 // TODO: reuse VPDerivedIVRecipe for base pointer computation when it
5796 // supports a general VPValue as the start value.
5797 VPValue *StartVPV =
5798 VPSCEVExpander(Builder, *PSE.getSE(), R.getDebugLoc()).expand(Start);
5799 VPValue *StrideInBytes = Plan.getOrAddLiveIn(Step->getValue());
5800 Type *IndexTy = Plan.getDataLayout().getIndexType(Ptr->getScalarType());
5801 assert(IndexTy == StrideInBytes->getScalarType() &&
5802 "Stride type from SCEV must match the index type");
5803 VPValue *CanIV = Builder.createScalarZExtOrTrunc(
5804 VectorLoop->getCanonicalIV(), IndexTy, DebugLoc::getUnknown());
5805 auto *AddRecPtr = cast<SCEVAddRecExpr>(PtrSCEV);
5806 auto *Offset = Builder.createOverflowingOp(
5807 Instruction::Mul, {CanIV, StrideInBytes},
5808 {AddRecPtr->hasNoUnsignedWrap(), /*HasNSW=*/false});
5809 GEPNoWrapFlags NWFlags = AddRecPtr->hasNoUnsignedWrap()
5812 VPValue *BasePtr = Builder.createNoWrapPtrAdd(StartVPV, Offset, NWFlags);
5813
5814 // Create a new vector pointer for strided access.
5815 VPValue *NewPtr = Builder.createVectorPointer(
5816 BasePtr, Type::getInt8Ty(Plan.getContext()), StrideInBytes, NWFlags,
5817 R.getDebugLoc());
5818
5819 VPValue *Mask = MemR->getMask();
5820 if (!Mask)
5821 Mask = Plan.getTrue();
5823 if (StoredValue)
5824 Ops.push_back(StoredValue);
5825 Ops.append({NewPtr, StrideInBytes, Mask, I32VF});
5826
5827 auto *StridedR = Builder.createWidenMemIntrinsic(
5828 IntrinID, Ops,
5829 StoredValue ? Type::getVoidTy(Plan.getContext()) : DataTy, Alignment,
5830 *MemR, R.getDebugLoc());
5831 if (!StoredValue)
5832 cast<VPWidenLoadRecipe>(&R)->replaceAllUsesWith(StridedR);
5833 R.eraseFromParent();
5834 }
5835 }
5836}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
unsigned uint64_t
This file implements a class to represent arbitrary precision integral constant values and operations...
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
static bool isEqual(const Function &Caller, const Function &Callee)
#define X(NUM, ENUM, NAME)
Definition ELF.h:857
static GCRegistry::Add< ShadowStackGC > C("shadow-stack", "Very portable GC for uncooperative code generators")
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")
static cl::opt< OutputCostKind > CostKind("cost-kind", cl::desc("Target cost kind"), cl::init(OutputCostKind::RecipThroughput), cl::values(clEnumValN(OutputCostKind::RecipThroughput, "throughput", "Reciprocal throughput"), clEnumValN(OutputCostKind::Latency, "latency", "Instruction latency"), clEnumValN(OutputCostKind::CodeSize, "code-size", "Code size"), clEnumValN(OutputCostKind::SizeAndLatency, "size-latency", "Code size and latency"), clEnumValN(OutputCostKind::All, "all", "Print all cost kinds")))
static cl::opt< IntrinsicCostStrategy > IntrinsicCost("intrinsic-cost-strategy", cl::desc("Costing strategy for intrinsic instructions"), cl::init(IntrinsicCostStrategy::InstructionCost), cl::values(clEnumValN(IntrinsicCostStrategy::InstructionCost, "instruction-cost", "Use TargetTransformInfo::getInstructionCost"), clEnumValN(IntrinsicCostStrategy::IntrinsicCost, "intrinsic-cost", "Use TargetTransformInfo::getIntrinsicInstrCost"), clEnumValN(IntrinsicCostStrategy::TypeBasedIntrinsicCost, "type-based-intrinsic-cost", "Calculate the intrinsic cost based only on argument types")))
@ Default
Hexagon Common GEP
#define _
iv Induction Variable Users
Definition IVUsers.cpp:48
iv users
Definition IVUsers.cpp:48
const AbstractManglingParser< Derived, Alloc >::OperatorInfo AbstractManglingParser< Derived, Alloc >::Ops[]
licm
Definition LICM.cpp:391
Legalize the Machine IR a function s Machine IR
Definition Legalizer.cpp:85
#define I(x, y, z)
Definition MD5.cpp:57
This file provides utility analysis objects describing memory locations.
This file contains the declarations for metadata subclasses.
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.
const SmallVectorImpl< MachineOperand > & Cond
Func MI getDebugLoc()))
This file contains some templates that are useful if you are working with the STL at all.
This is the interface for a metadata-based scoped no-alias analysis.
This file implements a set that has insertion order iteration characteristics.
This file defines the SmallPtrSet class.
static TableGen::Emitter::Opt Y("gen-skeleton-entry", EmitSkeleton, "Generate example skeleton entry")
This file implements the TypeSwitch template, which mimics a switch() statement whose cases are type ...
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.
static SmallVector< SmallVector< VPReplicateRecipe *, 4 > > collectComplementaryPredicatedMemOps(VPlan &Plan, PredicatedScalarEvolution &PSE, const Loop *L)
static void removeCommonBlendMask(VPBlendRecipe *Blend)
Try to see if all of Blend's masks share a common value logically and'ed and remove it from the masks...
static void tryToCreateAbstractReductionRecipe(VPReductionRecipe *Red, VPCostContext &Ctx, VFRange &Range)
This function tries to create abstract recipes from the reduction recipe for following optimizations ...
static VPReplicateRecipe * findRecipeWithMinAlign(ArrayRef< VPReplicateRecipe * > Group)
static bool handleUncountableExitsWithSideEffects(VPlan &Plan, SmallVectorImpl< EarlyExitInfo > &Exits, VPBasicBlock *HeaderVPBB, VPBasicBlock *LatchVPBB, VPBasicBlock *MiddleVPBB, Loop *TheLoop, PredicatedScalarEvolution &PSE, DominatorTree &DT, AssumptionCache *AC)
Update Plan to mask memory operations in the loop based on whether the early exit is taken or not.
static CallWideningDecision decideCallWidening(VPInstruction &VPI, ArrayRef< VPValue * > Ops, ElementCount VF, VPCostContext &CostCtx)
Pick the cheapest widening for the call VPI at VF among scalarization, vector intrinsic,...
static bool areVFParamsOk(const VFInfo &Info, ArrayRef< VPValue * > Args, PredicatedScalarEvolution &PSE, const Loop *L)
Returns true if Info's parameter kinds are compatible with Args.
static std::optional< VPValue * > getRecipesForUncountableExit(SmallVectorImpl< VPInstruction * > &Recipes, VPBasicBlock *LatchVPBB)
Returns the VPValue representing the uncountable exit comparison used by AnyOf if the recipes it depe...
static bool sinkScalarOperands(VPlan &Plan)
static std::optional< int64_t > getConstantStride(VPValue *Addr, Type *AccessTy, PredicatedScalarEvolution &PSE, const Loop *L)
If the pointer operand Addr of a memory access is an affine AddRec w.r.t.
static bool simplifyBranchConditionForVFAndUF(VPlan &Plan, ElementCount BestVF, unsigned BestUF, PredicatedScalarEvolution &PSE)
Try to simplify the branch condition of Plan.
static VPValue * cloneBinOpForScalarIV(VPWidenRecipe *BinOp, VPValue *ScalarIV, VPWidenIntOrFpInductionRecipe *WidenIV)
Create a scalar version of BinOp, with its WidenIV operand replaced by ScalarIV, and place it after S...
static VPWidenIntOrFpInductionRecipe * getExpressionIV(VPValue *V)
Check if V is a binary expression of a widened IV and a loop-invariant value.
static void removeRedundantInductionCasts(VPlan &Plan)
Remove redundant casts of inductions.
static bool isConditionTrueViaVFAndUF(VPValue *Cond, VPlan &Plan, ElementCount BestVF, unsigned BestUF, PredicatedScalarEvolution &PSE)
Return true if Cond is known to be true for given BestVF and BestUF.
static VPExpressionRecipe * tryToMatchAndCreateExtendedReduction(VPReductionRecipe *Red, VPCostContext &Ctx, VFRange &Range)
This function tries convert extended in-loop reductions to VPExpressionRecipe and clamp the Range if ...
static std::optional< ElementCount > isConsecutiveInterleaveGroup(VPInterleaveRecipe *InterleaveR, ArrayRef< ElementCount > VFs, const TargetTransformInfo &TTI)
Returns VF from VFs if IR is a full interleave group with factor and number of members both equal to ...
static Type * getLoadStoreValueType(VPReplicateRecipe *R, bool IsLoad)
Get the value type of the replicate load or store.
static VPIRMetadata getCommonMetadata(ArrayRef< VPReplicateRecipe * > Recipes)
static VPValue * simplifyLogicalRecipe(VPSingleDefRecipe *Def, VPBuilder &Builder, bool CanCreateNewRecipe)
Try to simplify logical and bitwise recipes in Def.
static bool mergeReplicateRegionsIntoSuccessors(VPlan &Plan)
static Function * findVectorVariant(CallInst *CI, ArrayRef< VPValue * > Args, ElementCount VF, bool MaskRequired, PredicatedScalarEvolution &PSE, const Loop *L)
Find a vector variant of CI for VF, respecting MaskRequired.
static VPWidenInductionRecipe * getOptimizableIVOf(VPValue *VPV, PredicatedScalarEvolution &PSE)
Check if VPV is an untruncated wide induction, either before or after the increment.
static bool canNarrowLoad(VPSingleDefRecipe *WideMember0, unsigned OpIdx, VPValue *OpV, unsigned Idx, bool IsScalable)
Returns true if V is VPWidenLoadRecipe or VPInterleaveRecipe that can be converted to a narrower reci...
static void legalizeAndOptimizeInductions(VPlan &Plan)
Legalize VPWidenPointerInductionRecipe, by replacing it with a PtrAdd (IndStart, ScalarIVSteps (0,...
static void addReplicateRegions(VPlan &Plan)
static VPValue * optimizeLatchExitIVUserViaSCEV(VPlan &Plan, VPValue *Op, PredicatedScalarEvolution &PSE, VPValue *ResumeTC, const Loop *L)
static SmallVector< SmallVector< VPReplicateRecipe *, 4 > > collectGroupedReplicateMemOps(VPlan &Plan, PredicatedScalarEvolution &PSE, const Loop *L, function_ref< bool(VPReplicateRecipe *)> FilterFn)
Collect either replicated Loads or Stores grouped by their address SCEV and their load-store type,...
static VPValue * tryToComputeEndValueForInduction(VPWidenInductionRecipe *WideIV, VPBuilder &VectorPHBuilder, VPValue *VectorTC)
Compute the end value for WideIV, unless it is truncated.
static bool replaceMaskWithCompareForScalarPlan(VPlan &Plan, ElementCount BestVF)
static void removeRedundantExpandSCEVRecipes(VPlan &Plan)
Remove redundant ExpandSCEVRecipes in Plan's entry block by replacing them with already existing reci...
static VPValue * optimizeEarlyExitInductionUser(VPlan &Plan, VPValue *Op, PredicatedScalarEvolution &PSE)
Attempts to optimize the induction variable exit values for users in the early exit block.
static VPValue * narrowInterleaveGroupOp(ArrayRef< VPValue * > Members, SmallPtrSetImpl< VPValue * > &NarrowedOps, VPBasicBlock *Preheader)
static VPValue * simplifyRecipe(VPSingleDefRecipe *Def)
Try to simplify VPSingleDefRecipe Def.
static VPValue * optimizeLatchExitInductionUser(VPlan &Plan, VPValue *Op, DenseMap< VPValue *, VPValue * > &EndValues, PredicatedScalarEvolution &PSE)
Attempts to optimize the induction variable exit values for users in the exit block coming from the l...
static void reassociateHeaderMask(VPlan &Plan)
Reassociate (headermask && x) && y -> headermask && (x && y) to allow the header mask to be simplifie...
static VPBasicBlock * getPredicatedThenBlock(VPRegionBlock *R)
If R is a triangle region, return the 'then' block of the triangle.
static bool canHoistOrSinkWithNoAliasCheck(const MemoryLocation &MemLoc, VPBasicBlock *FirstBB, VPBasicBlock *LastBB, std::optional< SinkStoreInfo > SinkInfo={})
Check if a memory operation doesn't alias with memory operations using scoped noalias metadata,...
static VPRegionBlock * createReplicateRegion(VPReplicateRecipe *PredRecipe, VPRegionBlock *ParentRegion, VPlan &Plan)
static void simplifyBlends(VPlan &Plan)
Normalize and simplify VPBlendRecipes.
static bool cannotHoistOrSinkRecipe(VPRecipeBase &R, VPBasicBlock *FirstBB, VPBasicBlock *LastBB, bool Sinking=false)
Return true if we do not know how to (mechanically) hoist or sink a non-memory or memory recipe R out...
static std::optional< Instruction::BinaryOps > getUnmaskedDivRemOpcode(Intrinsic::ID ID)
static bool isAlreadyNarrow(VPValue *VPV)
Returns true if VPValue is a narrow VPValue.
static bool canNarrowOps(ArrayRef< VPValue * > Ops, bool IsScalable)
static bool optimizeVectorInductionWidthForTCAndVFUF(VPlan &Plan, ElementCount BestVF, unsigned BestUF)
Optimize the width of vector induction variables in Plan based on a known constant Trip Count,...
static VPExpressionRecipe * tryToMatchAndCreateMulAccumulateReduction(VPReductionRecipe *Red, VPCostContext &Ctx, VFRange &Range)
This function tries convert extended in-loop reductions to VPExpressionRecipe and clamp the Range if ...
static bool canSinkStoreWithNoAliasCheck(ArrayRef< VPReplicateRecipe * > StoresToSink, PredicatedScalarEvolution &PSE, const Loop &L)
static std::optional< bool > getStepDirection(const SCEV *S, ScalarEvolution &SE)
If S is an affine AddRec, returns true if its step is known to be positive and false if it is known t...
static void narrowToSingleScalarRecipes(VPlan &Plan)
This file provides utility VPlan to VPlan transformations.
#define RUN_VPLAN_PASS(PASS,...)
This file contains the declarations of the Vectorization Plan base classes:
static const X86InstrFMA3Group Groups[]
Value * RHS
Value * LHS
BinaryOperator * Mul
static const uint32_t IV[8]
Definition blake3_impl.h:83
Helper for extra no-alias checks via known-safe recipe and SCEV.
SinkStoreInfo(ArrayRef< VPReplicateRecipe * > ExcludeRecipes, VPReplicateRecipe &GroupLeader, PredicatedScalarEvolution &PSE, const Loop &L)
SinkStoreInfo(VPReplicateRecipe &GroupLeader)
bool shouldSkip(VPRecipeBase &R) const
Return true if R should be skipped during alias checking, either because it's in the exclude set or b...
Class for arbitrary precision integers.
Definition APInt.h:78
LLVM_ABI APInt zextOrTrunc(unsigned width) const
Zero extend or truncate to width.
Definition APInt.cpp:1077
unsigned getActiveBits() const
Compute the number of active bits in the value.
Definition APInt.h:1533
APInt abs() const
Get the absolute value.
Definition APInt.h:1816
unsigned getBitWidth() const
Return the number of bits in the APInt.
Definition APInt.h:1509
int32_t exactLogBase2() const
Definition APInt.h:1804
bool isNonNegative() const
Determine if this APInt Value is non-negative (>= 0)
Definition APInt.h:331
LLVM_ABI APInt sext(unsigned width) const
Sign extend to a new width.
Definition APInt.cpp:1029
bool isPowerOf2() const
Check if this APInt's value is a power of two greater than zero.
Definition APInt.h:437
bool uge(const APInt &RHS) const
Unsigned greater or equal comparison.
Definition APInt.h:1226
An arbitrary precision integer that knows its signedness.
Definition APSInt.h:24
static APSInt getMinValue(uint32_t numBits, bool Unsigned)
Return the APSInt representing the minimum integer value with the given bit width and signedness.
Definition APSInt.h:310
static APSInt getMaxValue(uint32_t numBits, bool Unsigned)
Return the APSInt representing the maximum integer value with the given bit width and signedness.
Definition APSInt.h:302
@ NoAlias
The two locations do not alias at all.
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
const T & back() const
Get the last element.
Definition ArrayRef.h:150
ArrayRef< T > drop_front(size_t N=1) const
Drop the first N elements of the array.
Definition ArrayRef.h:194
const T & front() const
Get the first element.
Definition ArrayRef.h:144
A cache of @llvm.assume calls within a function.
LLVM Basic Block Representation.
Definition BasicBlock.h:62
const Function * getParent() const
Return the enclosing method, or null if none.
Definition BasicBlock.h:213
bool isNoBuiltin() const
Return true if the call should not be treated as a call to a builtin.
This class represents a function call, abstracting a target machine's calling convention.
@ ICMP_ULT
unsigned less than
Definition InstrTypes.h:765
@ ICMP_NE
not equal
Definition InstrTypes.h:762
@ ICMP_ULE
unsigned less or equal
Definition InstrTypes.h:766
@ FCMP_UNO
1 0 0 0 True if unordered: isnan(X) | isnan(Y)
Definition InstrTypes.h:750
Predicate getInversePredicate() const
For example, EQ -> NE, UGT -> ULE, SLT -> SGE, OEQ -> UNE, UGT -> OLE, OLT -> UGE,...
Definition InstrTypes.h:852
An abstraction over a floating-point predicate, and a pack of an integer predicate with samesign info...
This class represents a range of values.
LLVM_ABI bool contains(const APInt &Val) const
Return true if the specified value is in the set.
A parsed version of the target data layout string in and methods for querying it.
Definition DataLayout.h:64
LLVM_ABI IntegerType * getIndexType(LLVMContext &C, unsigned AddressSpace) const
Returns the type of a GEP index in AddressSpace.
A debug info location.
Definition DebugLoc.h:126
static DebugLoc getUnknown()
Definition DebugLoc.h:153
ValueT lookup(const_arg_type_t< KeyT > Val) const
Return the entry for the specified key, or a default constructed value if no such entry exists.
Definition DenseMap.h:250
std::pair< iterator, bool > try_emplace(KeyT &&Key, Ts &&...Args)
Definition DenseMap.h:299
ValueT lookup_or(const_arg_type_t< KeyT > Val, U &&Default) const
Definition DenseMap.h:260
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:122
static constexpr ElementCount getScalable(ScalarTy MinVal)
Definition TypeSize.h:312
constexpr bool isScalar() const
Exactly one element.
Definition TypeSize.h:320
Convenience struct for specifying and reasoning about fast-math flags.
Definition FMF.h:23
size_t arg_size() const
Definition Function.h:885
Represents flags for the getelementptr instruction/expression.
static GEPNoWrapFlags noUnsignedWrap()
bool hasNoUnsignedWrap() const
GEPNoWrapFlags withoutNoUnsignedWrap() const
static GEPNoWrapFlags none()
an instruction for type-safe pointer arithmetic to access elements of arrays and structs
A struct for saving information about induction variables.
InductionKind
This enum represents the kinds of inductions that we support.
@ IK_PtrInduction
Pointer induction var. Step = C.
@ IK_IntInduction
Integer induction variable. Step = C.
static InstructionCost getInvalid(CostType Val=0)
LLVM_ABI const Module * getModule() const
Return the module owning the function this instruction belongs to or nullptr it the function does not...
bool isBinaryOp() const
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this instruction belongs to.
bool isIntDivRem() const
static LLVM_ABI IntegerType * get(LLVMContext &C, unsigned NumBits)
This static method is the primary way of constructing an IntegerType.
Definition Type.cpp:348
The group of interleaved loads/stores sharing the same stride and close to each other.
This is an important class for using LLVM in a threaded context.
Definition LLVMContext.h:68
An instruction for reading from memory.
static bool getDecisionAndClampRange(const std::function< bool(ElementCount)> &Predicate, VFRange &Range)
Test a Predicate on a Range of VF's.
Definition VPlan.cpp:1681
Represents a single loop in the control flow graph.
Definition LoopInfo.h:40
This class implements a map that also provides access to all stored values in a deterministic order.
Definition MapVector.h:38
ValueT lookup(const KeyT &Key) const
Definition MapVector.h:110
std::pair< iterator, bool > try_emplace(const KeyT &Key, Ts &&...Args)
Definition MapVector.h:118
bool empty() const
Definition MapVector.h:79
Representation for a specific memory location.
Function * getFunction(StringRef Name) const
Look up the specified function in the module symbol table.
Definition Module.cpp:235
Post-order traversal of a graph.
An interface layer with SCEV used to manage how we see SCEV expressions for values in the context of ...
ScalarEvolution * getSE() const
Returns the ScalarEvolution analysis used.
LLVM_ABI const SCEV * getSCEV(Value *V)
Returns the SCEV expression of V, in the context of the current SCEV predicate.
static LLVM_ABI unsigned getOpcode(RecurKind Kind)
Returns the opcode corresponding to the RecurrenceKind.
static bool isFindLastRecurrenceKind(RecurKind Kind)
Returns true if the recurrence kind is of the form select(cmp(),x,y) where one of (x,...
RegionT * getParent() const
Get the parent of the Region.
Definition RegionInfo.h:362
This class represents a constant integer value.
ConstantInt * getValue() const
static const SCEV * rewrite(const SCEV *Scev, ScalarEvolution &SE, ValueToSCEVMapTy &Map)
This class represents an analyzed expression in the program.
Type * getType() const
Return the LLVM type of this SCEV expression.
The main scalar evolution driver.
const DataLayout & getDataLayout() const
Return the DataLayout associated with the module this SCEV instance is operating on.
LLVM_ABI const SCEV * getNegativeSCEV(const SCEV *V, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap)
Return the SCEV object corresponding to -V.
LLVM_ABI bool isKnownNegative(const SCEV *S)
Test if the given expression is known to be negative.
LLVM_ABI const SCEV * getConstant(ConstantInt *V)
LLVM_ABI const SCEV * getMinusSCEV(SCEVUse LHS, SCEVUse RHS, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap, unsigned Depth=0)
Return LHS-RHS.
ConstantRange getSignedRange(const SCEV *S)
Determine the signed range for a particular SCEV.
LLVM_ABI bool isLoopInvariant(const SCEV *S, const Loop *L)
Return true if the value of the given SCEV is unchanging in the specified loop.
LLVM_ABI bool isKnownPositive(const SCEV *S)
Test if the given expression is known to be positive.
LLVM_ABI const SCEV * getElementCount(Type *Ty, ElementCount EC, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap)
ConstantRange getUnsignedRange(const SCEV *S)
Determine the unsigned range for a particular SCEV.
LLVM_ABI bool isKnownPredicate(CmpPredicate Pred, SCEVUse LHS, SCEVUse RHS)
Test if the given expression is known to satisfy the condition described by Pred, LHS,...
static LLVM_ABI AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB)
A vector that has set insertion semantics.
Definition SetVector.h:57
size_type size() const
Determine the number of elements in the SetVector.
Definition SetVector.h:103
bool insert(const value_type &X)
Insert a new element into the SetVector.
Definition SetVector.h:157
size_type size() const
Definition SmallPtrSet.h:99
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
iterator begin() const
bool contains(ConstPtrType Ptr) const
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
An instruction for storing to memory.
Provides information about what library functions are available for the current target.
This pass provides access to the codegen interfaces that are needed for IR-level transformations.
static LLVM_ABI PartialReductionExtendKind getPartialReductionExtendKind(Instruction *I)
Get the kind of extension that an instruction represents.
TargetCostKind
The kind of cost model.
@ TCK_RecipThroughput
Reciprocal throughput.
LLVM_ABI InstructionCost getPartialReductionCost(unsigned Opcode, Type *InputTypeA, Type *InputTypeB, Type *AccumType, ElementCount VF, PartialReductionExtendKind OpAExtend, PartialReductionExtendKind OpBExtend, std::optional< unsigned > BinOp, TTI::TargetCostKind CostKind, std::optional< FastMathFlags > FMF) const
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
This class implements a switch-like dispatch statement for a value of 'T' using dyn_cast functionalit...
Definition TypeSwitch.h:89
TypeSwitch< T, ResultT > & Case(CallableT &&caseFn)
Add a case on the given type.
Definition TypeSwitch.h:98
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
static LLVM_ABI IntegerType * getInt32Ty(LLVMContext &C)
Definition Type.cpp:309
bool isPointerTy() const
True if this is an instance of PointerType.
Definition Type.h:282
static LLVM_ABI Type * getVoidTy(LLVMContext &C)
Definition Type.cpp:282
static LLVM_ABI IntegerType * getInt8Ty(LLVMContext &C)
Definition Type.cpp:307
Type * getScalarType() const
If this is a vector type, return the element type, otherwise return 'this'.
Definition Type.h:368
LLVM_ABI TypeSize getPrimitiveSizeInBits() const LLVM_READONLY
Return the basic size of this type if it is a primitive type.
Definition Type.cpp:197
LLVM_ABI unsigned getScalarSizeInBits() const LLVM_READONLY
If this is a vector type, return the getPrimitiveSizeInBits value for the element type.
Definition Type.cpp:232
bool isFloatingPointTy() const
Return true if this is one of the floating-point types.
Definition Type.h:186
bool isIntOrPtrTy() const
Return true if this is an integer type or a pointer type.
Definition Type.h:270
bool isIntegerTy() const
True if this is an instance of IntegerType.
Definition Type.h:257
op_range operands()
Definition User.h:267
static SmallVector< VFInfo, 8 > getMappings(const CallInst &CI)
Retrieve all the VFInfo instances associated to the CallInst CI.
Definition VectorUtils.h:76
bool isLegalMaskedLoadOrStore(bool IsLoad, Type *ScalarTy, Align Alignment, unsigned AddressSpace) const
Returns true if the target machine supports a masked load (if IsLoad) or masked store of scalar type ...
VPBasicBlock serves as the leaf of the Hierarchical Control-Flow Graph.
Definition VPlan.h:4400
void appendRecipe(VPRecipeBase *Recipe)
Augment the existing recipes of a VPBasicBlock with an additional Recipe as the last recipe.
Definition VPlan.h:4475
iterator end()
Definition VPlan.h:4437
iterator begin()
Recipe iterator methods.
Definition VPlan.h:4435
iterator_range< iterator > phis()
Returns an iterator range over the PHI-like recipes in the block.
Definition VPlan.h:4488
iterator getFirstNonPhi()
Return the position of the first non-phi node recipe in the block.
Definition VPlan.cpp:266
VPBasicBlock * splitAt(iterator SplitAt)
Split current block at SplitAt by inserting a new block between the current block and its successors ...
Definition VPlan.cpp:584
const VPRecipeBase & front() const
Definition VPlan.h:4447
VPRecipeBase * getTerminator()
If the block has multiple successors, return the branch recipe terminating the block.
Definition VPlan.cpp:663
const VPRecipeBase & back() const
Definition VPlan.h:4449
A recipe for vectorizing a phi-node as a sequence of mask-based select instructions.
Definition VPlan.h:2963
VPValue * getIncomingValue(unsigned Idx) const
Return incoming value number Idx.
Definition VPlan.h:3010
VPValue * getMask(unsigned Idx) const
Return mask number Idx.
Definition VPlan.h:3015
unsigned getNumIncomingValues() const
Return the number of incoming values, taking into account when normalized the first incoming value wi...
Definition VPlan.h:3005
void setMask(unsigned Idx, VPValue *V)
Set mask number Idx to V.
Definition VPlan.h:3021
bool isNormalized() const
A normalized blend is one that has an odd number of operands, whereby the first operand does not have...
Definition VPlan.h:3001
VPBlockBase is the building block of the Hierarchical Control-Flow Graph.
Definition VPlan.h:93
void setSuccessors(ArrayRef< VPBlockBase * > NewSuccs)
Set each VPBasicBlock in NewSuccss as successor of this VPBlockBase.
Definition VPlan.h:314
VPRegionBlock * getParent()
Definition VPlan.h:191
const VPBasicBlock * getExitingBasicBlock() const
Definition VPlan.cpp:236
size_t getNumSuccessors() const
Definition VPlan.h:242
void setPredecessors(ArrayRef< VPBlockBase * > NewPreds)
Set each VPBasicBlock in NewPreds as predecessor of this VPBlockBase.
Definition VPlan.h:305
const VPBlocksTy & getPredecessors() const
Definition VPlan.h:227
VPBlockBase * getSinglePredecessor() const
Definition VPlan.h:238
const VPBasicBlock * getEntryBasicBlock() const
Definition VPlan.cpp:216
VPBlockBase * getSingleSuccessor() const
Definition VPlan.h:232
const VPBlocksTy & getSuccessors() const
Definition VPlan.h:216
static auto blocksAs(T &&Range)
Return an iterator range over Range with each block cast to BlockTy.
Definition VPlanUtils.h:405
static void insertOnEdge(VPBlockBase *From, VPBlockBase *To, VPBlockBase *BlockPtr)
Inserts BlockPtr on the edge between From and To.
Definition VPlanUtils.h:424
static bool isLatch(const VPBlockBase *VPB, const VPDominatorTree &VPDT)
Returns true if VPB is a loop latch, using isHeader().
static VPBasicBlock * getPlainCFGMiddleBlock(const VPlan &Plan)
Returns the middle block of Plan in plain CFG form (before regions are formed).
static void insertTwoBlocksAfter(VPBlockBase *IfTrue, VPBlockBase *IfFalse, VPBlockBase *BlockPtr)
Insert disconnected VPBlockBases IfTrue and IfFalse after BlockPtr.
Definition VPlanUtils.h:315
static void connectBlocks(VPBlockBase *From, VPBlockBase *To, unsigned PredIdx=-1u, unsigned SuccIdx=-1u)
Connect VPBlockBases From and To bi-directionally.
Definition VPlanUtils.h:333
static void disconnectBlocks(VPBlockBase *From, VPBlockBase *To)
Disconnect VPBlockBases From and To bi-directionally.
Definition VPlanUtils.h:351
static auto blocksOnly(T &&Range)
Return an iterator range over Range which only includes BlockTy blocks.
Definition VPlanUtils.h:387
static std::pair< VPBasicBlock *, VPBasicBlock * > getPlainCFGHeaderAndLatch(const VPlan &Plan)
Returns the header and latch of the outermost loop of Plan in plain CFG form (before regions are form...
static void transferSuccessors(VPBlockBase *Old, VPBlockBase *New)
Transfer successors from Old to New. New must have no successors.
Definition VPlanUtils.h:371
static SmallVector< VPBasicBlock * > blocksInSingleSuccessorChainBetween(VPBasicBlock *FirstBB, VPBasicBlock *LastBB)
Returns the blocks between FirstBB and LastBB, where FirstBB to LastBB forms a single-sucessor chain.
A recipe for generating conditional branches on the bits of a mask.
Definition VPlan.h:3513
VPlan-based builder utility analogous to IRBuilder.
VPInstruction * createFirstActiveLane(ArrayRef< VPValue * > Masks, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPWidenStoreRecipe * createWidenStore(StoreInst &Store, VPValue *Addr, VPValue *StoredVal, VPValue *Mask, bool Consecutive, const VPIRMetadata &Metadata, DebugLoc DL)
Create a recipe widening Store, storing StoredVal to Addr with Mask (may be null).
VPInstruction * createAdd(VPValue *LHS, VPValue *RHS, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="", VPRecipeWithIRFlags::WrapFlagsTy WrapFlags={false, false})
VPInstruction * createOr(VPValue *LHS, VPValue *RHS, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction * createLogicalOr(VPValue *LHS, VPValue *RHS, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPWidenLoadRecipe * createWidenLoad(LoadInst &Load, VPValue *Addr, VPValue *Mask, bool Consecutive, const VPIRMetadata &Metadata, DebugLoc DL)
Create a recipe widening Load, loading from Addr with Mask (may be null).
VPInstruction * createNot(VPValue *Operand, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction * createAnyOfReduction(VPValue *ChainOp, VPValue *TrueVal, VPValue *FalseVal, DebugLoc DL=DebugLoc::getUnknown())
Create an AnyOf reduction pattern: or-reduce ChainOp, freeze the result, then select between TrueVal ...
Definition VPlan.cpp:1668
void setInsertPoint(const VPInsertPoint &IP)
Set the current insert point.
VPInstruction * createLogicalAnd(VPValue *LHS, VPValue *RHS, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
VPInstruction * createScalarCast(Instruction::CastOps Opcode, VPValue *Op, Type *ResultTy, DebugLoc DL, std::optional< VPIRFlags > Flags=std::nullopt, const VPIRMetadata &Metadata={})
VPValue * createScalarZExtOrTrunc(VPValue *Op, Type *ResultTy, DebugLoc DL)
static VPBuilder getToInsertAfter(VPRecipeBase *R)
Create a VPBuilder to insert after R.
VPDerivedIVRecipe * createDerivedIV(InductionDescriptor::InductionKind Kind, FPMathOperator *FPBinOp, VPValue *Start, VPValue *Current, VPValue *Step, const VPIRFlags::WrapFlagsTy &Flags={})
Convert Current to Start + Current * Step.
VPWidenCastRecipe * createWidenCast(Instruction::CastOps Opcode, VPValue *Op, Type *ResultTy)
VPInstruction * createICmp(CmpInst::Predicate Pred, VPValue *A, VPValue *B, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="")
Create a new ICmp VPInstruction with predicate Pred and operands A and B.
VPInstruction * createSelect(VPValue *Cond, VPValue *TrueVal, VPValue *FalseVal, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="", std::optional< VPIRFlags > Flags=std::nullopt)
Create a select of TrueVal and FalseVal based on Cond, using the default flags for the result type,...
VPInstruction * createNaryOp(unsigned Opcode, ArrayRef< VPValue * > Operands, Instruction *Inst=nullptr, const VPIRFlags &Flags={}, const VPIRMetadata &MD={}, DebugLoc DL=DebugLoc::getUnknown(), const Twine &Name="", Type *ResultTy=nullptr)
Create an N-ary operation with Opcode, Operands and set Inst as its underlying Instruction.
static VPSingleDefRecipe * createSingleScalarOp(unsigned Opcode, ArrayRef< VPValue * > Operands, VPValue *Mask, const VPIRFlags &Flags, const VPIRMetadata &Metadata, DebugLoc DL, Instruction *UV)
Create a single-scalar recipe with Opcode and Operands without inserting it.
unsigned getNumDefinedValues() const
Returns the number of values defined by the VPDef.
Definition VPlanValue.h:578
VPValue * getVPSingleValue()
Returns the only VPValue defined by the VPDef.
Definition VPlanValue.h:551
VPValue * getVPValue(unsigned I)
Returns the VPValue with index I defined by the VPDef.
Definition VPlanValue.h:563
ArrayRef< VPRecipeValue * > definedValues()
Returns an ArrayRef of the values defined by the VPDef.
Definition VPlanValue.h:573
Template specialization of the standard LLVM dominator tree utility for VPBlockBases.
bool properlyDominates(const VPRecipeBase *A, const VPRecipeBase *B) const
A recipe to combine multiple recipes into a single 'expression' recipe, which should be considered a ...
Definition VPlan.h:3558
A pure virtual base class for all recipes modeling header phis, including phis for first order recurr...
Definition VPlan.h:2451
virtual VPValue * getBackedgeValue()
Returns the incoming value from the loop backedge.
Definition VPlan.h:2498
VPValue * getStartValue()
Returns the start value of the phi, if one is set.
Definition VPlan.h:2487
A recipe representing a sequence of load -> update -> store as part of a histogram operation.
Definition VPlan.h:2178
A special type of VPBasicBlock that wraps an existing IR basic block.
Definition VPlan.h:4553
Class to record and manage LLVM IR flags.
Definition VPlan.h:703
static VPIRFlags getDefaultFlags(unsigned Opcode, Type *ResultTy=nullptr)
Returns default flags for Opcode and scalar ResultTy for opcodes that support it, asserts otherwise.
LLVM_ABI_FOR_TEST FastMathFlags getFastMathFlagsOrNone() const
Helper to manage IR metadata for recipes.
Definition VPlan.h:1180
void intersect(const VPIRMetadata &MD)
Intersect this VPIRMetadata object with MD, keeping only metadata nodes that are common to both.
This is a concrete Recipe that models a single VPlan-level instruction.
Definition VPlan.h:1235
unsigned getNumOperandsWithoutMask() const
Returns the number of operands, excluding the mask if the VPInstruction is masked.
Definition VPlan.h:1485
@ ExtractLane
Extracts a single lane (first operand) from a set of vector operands.
Definition VPlan.h:1336
@ ReductionStartVector
Start vector for reductions with 3 operands: the original start value, the identity value for the red...
Definition VPlan.h:1332
@ BuildVector
Creates a fixed-width vector containing all operands.
Definition VPlan.h:1281
@ ComputeReductionResult
Reduce the operands to the final reduction result using the operation specified via the operation's V...
Definition VPlan.h:1289
unsigned getOpcode() const
Definition VPlan.h:1429
VPValue * getMask() const
Returns the mask for the VPInstruction.
Definition VPlan.h:1501
const InterleaveGroup< Instruction > * getInterleaveGroup() const
Definition VPlan.h:3116
VPValue * getMask() const
Return the mask used by this recipe.
Definition VPlan.h:3108
ArrayRef< VPValue * > getStoredValues() const
Return the VPValues stored by this interleave group.
Definition VPlan.h:3137
VPInterleaveRecipe is a recipe for transforming an interleave group of load or stores into one wide l...
Definition VPlan.h:3147
VPPredInstPHIRecipe is a recipe for generating the phi nodes needed when control converges back from ...
Definition VPlan.h:3719
VPRecipeBase is a base class modeling a sequence of one or more output IR instructions.
Definition VPlan.h:410
VPRegionBlock * getRegion()
Definition VPlan.h:4799
VPBasicBlock * getParent()
Definition VPlan.h:482
DebugLoc getDebugLoc() const
Returns the debug location of the recipe.
Definition VPlan.h:560
void moveBefore(VPBasicBlock &BB, iplist< VPRecipeBase >::iterator I)
Unlink this recipe and insert into BB before I.
void insertBefore(VPRecipeBase *InsertPos)
Insert an unlinked recipe into a basic block immediately before the specified recipe.
void insertAfter(VPRecipeBase *InsertPos)
Insert an unlinked Recipe into a basic block immediately after the specified Recipe.
iplist< VPRecipeBase >::iterator eraseFromParent()
This method unlinks 'this' from the containing basic block and deletes it.
Helper class to create VPRecipies from IR instructions.
VPHistogramRecipe * widenIfHistogram(VPInstruction *VPI)
If VPI represents a histogram operation (as determined by LoopVectorizationLegality) make that safe f...
bool prefersVectorizedAddressing() const
Returns true if the target prefers vectorized addressing.
VPRecipeBase * tryToWidenMemory(VPInstruction *VPI, VFRange &Range)
Check if the load or store instruction VPI should widened for Range.Start and potentially masked.
bool replaceWithFinalIfReductionStore(VPInstruction *VPI, VPBuilder &FinalRedStoresBuilder)
If VPI is a store of a reduction into an invariant address, delete it.
VPSingleDefRecipe * handleReplication(VPInstruction *VPI, VFRange &Range)
Build a replicating or single-scalar recipe for VPI.
bool isPredicatedInst(Instruction *I) const
Returns true if I needs to be predicated (i.e.
Type * getScalarType() const
Returns the scalar type of this VPRecipeValue.
Definition VPlanValue.h:354
A recipe for handling reduction phis.
Definition VPlan.h:2870
void setVFScaleFactor(unsigned ScaleFactor)
Set the VFScaleFactor for this reduction phi.
Definition VPlan.h:2921
unsigned getVFScaleFactor() const
Get the factor that the VF of this recipe's output should be scaled by, or 1 if it isn't scaled.
Definition VPlan.h:2914
RecurKind getRecurrenceKind() const
Returns the recurrence kind of the reduction.
Definition VPlan.h:2927
A recipe to represent inloop, ordered or partial reduction operations.
Definition VPlan.h:3240
VPRegionBlock represents a collection of VPBasicBlocks and VPRegionBlocks which form a Single-Entry-S...
Definition VPlan.h:4625
const VPBlockBase * getEntry() const
Definition VPlan.h:4669
bool isReplicator() const
An indicator whether this region is to generate multiple replicated instances of output IR correspond...
Definition VPlan.h:4701
void setExiting(VPBlockBase *ExitingBlock)
Set ExitingBlock as the exiting VPBlockBase of this VPRegionBlock.
Definition VPlan.h:4686
Type * getCanonicalIVType() const
Return the type of the canonical IV for loop regions.
Definition VPlan.h:4753
VPRegionValue * getCanonicalIV()
Return the canonical induction variable of the region, null for replicating regions.
Definition VPlan.h:4745
const VPBlockBase * getExiting() const
Definition VPlan.h:4681
VPRegionValue * getHeaderMask() const
Return the header mask of the region, or null if not set.
Definition VPlan.h:4758
VPReplicateRecipe replicates a given instruction producing multiple scalar copies of the original sca...
Definition VPlan.h:3405
bool isSingleScalar() const
Returns true if the recipe produces a single scalar value.
Definition VPlan.h:3464
static InstructionCost computeCallCost(Function *CalledFn, Type *ResultTy, ArrayRef< const VPValue * > ArgOps, bool IsSingleScalar, ElementCount VF, VPCostContext &Ctx)
Return the cost of scalarizing a call to CalledFn with argument operands ArgOps for a given VF.
operand_range operandsWithoutMask()
Return the recipe's operands, excluding the mask of a predicated recipe.
Definition VPlan.h:3492
bool isPredicated() const
Definition VPlan.h:3469
VPValue * getMask()
Return the mask of a predicated VPReplicateRecipe.
Definition VPlan.h:3486
Lightweight SCEV-to-VPlan expander.
Definition VPlanUtils.h:250
VPValue * expand(const SCEV *S)
Expand S into recipes and live-ins using the builder.
A recipe for handling phi nodes of integer and floating-point inductions, producing their scalar valu...
Definition VPlan.h:4255
VPSingleDefRecipe is a base class for recipes that model a sequence of one or more output IR that def...
Definition VPlan.h:618
Instruction * getUnderlyingInstr()
Returns the underlying instruction.
Definition VPlan.h:688
VPSingleDefRecipe * clone() override=0
Clone the current recipe.
A symbolic live-in VPValue, used for values like vector trip count, VF, and VFxUF.
Definition VPlanValue.h:217
This class augments VPValue with operands which provide the inverse def-use edges from VPValue's user...
Definition VPlanValue.h:401
operand_range operands()
Definition VPlanValue.h:474
void setOperand(unsigned I, VPValue *New)
Definition VPlanValue.h:447
unsigned getNumOperands() const
Definition VPlanValue.h:441
VPValue * getOperand(unsigned N) const
Definition VPlanValue.h:442
This is the base class of the VPlan Def/Use graph, used for modeling the data flow into,...
Definition VPlanValue.h:50
Type * getScalarType() const
Returns the scalar type of this VPValue, dispatching based on the concrete subclass.
Definition VPlan.cpp:149
Value * getLiveInIRValue() const
Return the underlying IR value for a VPIRValue.
Definition VPlan.cpp:143
bool isDefinedOutsideLoopRegions() const
Returns true if the VPValue is defined outside any loop.
Definition VPlan.cpp:1492
VPRecipeBase * getDefiningRecipe()
Returns the recipe defining this VPValue or nullptr if it is not defined by a recipe,...
Definition VPlan.cpp:130
bool hasMoreThanOneUniqueUser() const
Returns true if the value has more than one unique user.
Definition VPlanValue.h:164
Value * getUnderlyingValue() const
Return the underlying Value attached to this VPValue.
Definition VPlanValue.h:75
bool user_empty() const
Definition VPlanValue.h:161
bool hasOneUse() const
Definition VPlanValue.h:175
VPUser * getSingleUser()
Return the single user of this value, or nullptr if there is not exactly one user.
Definition VPlanValue.h:179
void replaceAllUsesWith(VPValue *New)
Definition VPlan.cpp:1495
unsigned getNumUsers() const
Definition VPlanValue.h:115
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:1501
user_range users()
Definition VPlanValue.h:157
A recipe to compute a pointer to the last element of each part of a widened memory access for widened...
Definition VPlan.h:2281
A recipe for widening Call instructions using library calls.
Definition VPlan.h:2112
static InstructionCost computeCallCost(Function *Variant, VPCostContext &Ctx)
Return the cost of widening a call using the vector function Variant.
VPWidenCastRecipe is a recipe to create vector cast instructions.
Definition VPlan.h:1894
Instruction::CastOps getOpcode() const
Definition VPlan.h:1930
A recipe for handling GEP instructions.
Definition VPlan.h:2221
Base class for widened induction (VPWidenIntOrFpInductionRecipe and VPWidenPointerInductionRecipe),...
Definition VPlan.h:2525
VPIRValue * getStartValue() const
Returns the start value of the induction.
Definition VPlan.h:2573
PHINode * getPHINode() const
Returns the underlying PHINode if one exists, or null otherwise.
Definition VPlan.h:2591
VPValue * getStepValue()
Returns the step value of the induction.
Definition VPlan.h:2576
const InductionDescriptor & getInductionDescriptor() const
Returns the induction descriptor for the recipe.
Definition VPlan.h:2596
A recipe for handling phi nodes of integer and floating-point inductions, producing their vector valu...
Definition VPlan.h:2625
TruncInst * getTruncInst()
Returns the first defined value as TruncInst, if it is one or nullptr otherwise.
Definition VPlan.h:2684
A recipe for widening vector intrinsics.
Definition VPlan.h:1941
static InstructionCost computeCallCost(Intrinsic::ID ID, ArrayRef< const VPValue * > Operands, const VPRecipeWithIRFlags &R, ElementCount VF, VPCostContext &Ctx)
Compute the cost of a vector intrinsic with ID and Operands.
static InstructionCost computeMemIntrinsicCost(Intrinsic::ID IID, Type *Ty, bool IsMasked, Align Alignment, VPCostContext &Ctx)
Helper function for computing the cost of vector memory intrinsic.
A common mixin class for widening memory operations.
Definition VPlan.h:3755
virtual VPRecipeBase * getAsRecipe()=0
Return a VPRecipeBase* to the current object.
A recipe for widened phis.
Definition VPlan.h:2757
VPWidenRecipe is a recipe for producing a widened instruction using the opcode and operands of the re...
Definition VPlan.h:1828
InstructionCost computeCost(ElementCount VF, VPCostContext &Ctx) const override
Return the cost of this VPWidenRecipe.
VPWidenRecipe * clone() override
Clone the current recipe.
Definition VPlan.h:1854
unsigned getOpcode() const
Definition VPlan.h:1873
VPlan models a candidate for vectorization, encoding various decisions take to produce efficient outp...
Definition VPlan.h:4812
VPIRValue * getLiveIn(Value *V) const
Return the live-in VPIRValue for V, if there is one or nullptr otherwise.
Definition VPlan.h:5151
bool hasVF(ElementCount VF) const
Definition VPlan.h:5044
const DataLayout & getDataLayout() const
Definition VPlan.h:5026
LLVMContext & getContext() const
Definition VPlan.h:5022
VPBasicBlock * getEntry()
Definition VPlan.h:4908
bool hasScalableVF() const
Definition VPlan.h:5045
VPValue * getTripCount() const
The trip count of the original loop.
Definition VPlan.h:4980
VPValue * getOrCreateBackedgeTakenCount()
The backedge taken count of the original loop.
Definition VPlan.h:5001
iterator_range< SmallSetVector< ElementCount, 2 >::iterator > vectorFactors() const
Returns an iterator range over all VFs of the plan.
Definition VPlan.h:5051
VPIRValue * getFalse()
Return a VPIRValue wrapping i1 false.
Definition VPlan.h:5117
VPSymbolicValue & getVFxUF()
Returns VF * UF of the vector loop region.
Definition VPlan.h:5020
VPIRValue * getAllOnesValue(Type *Ty)
Return a VPIRValue wrapping the AllOnes value of type Ty.
Definition VPlan.h:5123
VPRegionBlock * createReplicateRegion(VPBlockBase *Entry, VPBlockBase *Exiting, const std::string &Name="")
Create a new replicate region with Entry, Exiting and Name.
Definition VPlan.h:5202
auto getLiveIns() const
Return the list of live-in VPValues available in the VPlan.
Definition VPlan.h:5154
bool hasUF(unsigned UF) const
Definition VPlan.h:5069
ArrayRef< VPIRBasicBlock * > getExitBlocks() const
Return an ArrayRef containing VPIRBasicBlocks wrapping the exit blocks of the original scalar loop.
Definition VPlan.h:4974
VPSymbolicValue & getVectorTripCount()
The vector trip count.
Definition VPlan.h:5010
VPValue * getBackedgeTakenCount() const
Definition VPlan.h:5007
VPIRValue * getOrAddLiveIn(Value *V)
Gets the live-in VPIRValue for V or adds a new live-in (if none exists yet) for V.
Definition VPlan.h:5094
VPIRValue * getZero(Type *Ty)
Return a VPIRValue wrapping the null value of type Ty.
Definition VPlan.h:5120
void setVF(ElementCount VF)
Definition VPlan.h:5032
bool isUnrolled() const
Returns true if the VPlan already has been unrolled, i.e.
Definition VPlan.h:5085
LLVM_ABI_FOR_TEST VPRegionBlock * getVectorLoopRegion()
Returns the VPRegionBlock of the vector loop.
Definition VPlan.cpp:1080
unsigned getConcreteUF() const
Returns the concrete UF of the plan, after unrolling.
Definition VPlan.h:5072
void resetTripCount(VPValue *NewTripCount)
Resets the trip count for the VPlan.
Definition VPlan.h:4994
VPBasicBlock * getMiddleBlock()
Returns the 'middle' block of the plan, that is the block that selects whether to execute the scalar ...
Definition VPlan.h:4950
VPBasicBlock * createVPBasicBlock(const Twine &Name, VPRecipeBase *Recipe=nullptr)
Create a new VPBasicBlock with Name and containing Recipe if present.
Definition VPlan.h:5177
VPIRValue * getTrue()
Return a VPIRValue wrapping i1 true.
Definition VPlan.h:5114
VPBasicBlock * getVectorPreheader() const
Returns the preheader of the vector loop region, if one exists, or null otherwise.
Definition VPlan.h:4913
VPSymbolicValue & getUF()
Returns the UF of the vector loop region.
Definition VPlan.h:5017
bool hasScalarVFOnly() const
Definition VPlan.h:5062
VPBasicBlock * getScalarPreheader() const
Return the VPBasicBlock for the preheader of the scalar loop.
Definition VPlan.h:4964
bool hasTailFolded() const
Returns true if the vector loop region is tail-folded.
Definition VPlan.h:4929
VPSymbolicValue & getVF()
Returns the VF of the vector loop region.
Definition VPlan.h:5013
LLVM_ABI_FOR_TEST VPlan * duplicate()
Clone the current VPlan, update all VPValues of the new VPlan and cloned recipes to refer to the clon...
Definition VPlan.cpp:1240
VPIRValue * getConstantInt(Type *Ty, uint64_t Val, bool IsSigned=false)
Return a VPIRValue wrapping a ConstantInt with the given type and value.
Definition VPlan.h:5128
LLVM Value Representation.
Definition Value.h:75
iterator_range< user_iterator > users()
Definition Value.h:426
bool hasName() const
Definition Value.h:261
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
constexpr bool hasKnownScalarFactor(const FixedOrScalableQuantity &RHS) const
Returns true if there exists a value X where RHS.multiplyCoefficientBy(X) will result in a value whos...
Definition TypeSize.h:269
constexpr ScalarTy getFixedValue() const
Definition TypeSize.h:200
constexpr ScalarTy getKnownScalarFactor(const FixedOrScalableQuantity &RHS) const
Returns a value X where RHS.multiplyCoefficientBy(X) will result in a value whose quantity matches ou...
Definition TypeSize.h:277
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:168
constexpr LeafTy multiplyCoefficientBy(ScalarTy RHS) const
Definition TypeSize.h:256
constexpr bool isFixed() const
Returns true if the quantity is not scaled by vscale.
Definition TypeSize.h:171
constexpr ScalarTy getKnownMinValue() const
Returns the minimum value this quantity can represent.
Definition TypeSize.h:165
An efficient, type-erasing, non-owning reference to a callable.
self_iterator getIterator()
Definition ilist_node.h:123
Changed
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
LLVM_ABI APInt RoundingUDiv(const APInt &A, const APInt &B, APInt::Rounding RM)
Return A unsign-divided by B, rounded by the given rounding mode.
Definition APInt.cpp:2799
std::variant< std::monostate, Loc::Single, Loc::Multi, Loc::MMI, Loc::EntryValue > Variant
Alias for the std::variant specialization base class of DbgVariable.
Definition DwarfDebug.h:190
SpecificConstantMatch m_ZeroInt()
Convenience matchers for specific integer values.
AllOnesConstantMatch m_AllOnes()
BinaryOp_match< SrcTy, SpecificConstantMatch, TargetOpcode::G_XOR, true > m_Not(const SrcTy &&Src)
Matches a register not-ed by a G_XOR.
OneUse_match< SubPat > m_OneUse(const SubPat &SP)
match_unless< Pattern > m_Unless(const Pattern &P)
Match if the inner matcher does NOT match.
match_combine_or< Ty... > m_CombineOr(const Ty &...Ps)
Combine pattern matchers matching any of Ps patterns.
auto m_Cmp()
Matches any compare instruction and ignore it.
BinaryOp_match< LHS, RHS, Instruction::Add > m_Add(const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::URem > m_URem(const LHS &L, const RHS &R)
ap_match< APInt > m_APInt(const APInt *&Res)
Match a ConstantInt or splatted ConstantVector, binding the specified pointer to the contained APInt.
CastInst_match< OpTy, TruncInst > m_Trunc(const OpTy &Op)
Matches Trunc.
LogicalOp_match< LHS, RHS, Instruction::And > m_LogicalAnd(const LHS &L, const RHS &R)
Matches L && R either in the form of L & R or L ?
specific_intval< false > m_SpecificInt(const APInt &V)
Match a specific integer value or vector with all elements equal to the value.
BinaryOp_match< LHS, RHS, Instruction::FMul > m_FMul(const LHS &L, const RHS &R)
bool match(Val *V, const Pattern &P)
match_deferred< Value > m_Deferred(Value *const &V)
Like m_Specific(), but works if the specific value to match is determined as part of the same match()...
specificval_ty m_Specific(const Value *V)
Match if we have a specific specified value.
auto match_fn(const Pattern &P)
A match functor that can be used as a UnaryPredicate in functional algorithms like all_of.
cst_pred_ty< is_one > m_One()
Match an integer 1 or a vector with all elements equal to 1.
ThreeOps_match< Cond, LHS, RHS, Instruction::Select > m_Select(const Cond &C, const LHS &L, const RHS &R)
Matches SelectInst.
SpecificCmpClass_match< LHS, RHS, CmpInst > m_SpecificCmp(CmpPredicate MatchPred, const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::Mul > m_Mul(const LHS &L, const RHS &R)
CastInst_match< OpTy, FPExtInst > m_FPExt(const OpTy &Op)
SpecificCmpClass_match< LHS, RHS, ICmpInst > m_SpecificICmp(CmpPredicate MatchPred, const LHS &L, const RHS &R)
BinaryOp_match< LHS, RHS, Instruction::UDiv > m_UDiv(const LHS &L, const RHS &R)
SelectLike_match< CondTy, LTy, RTy > m_SelectLike(const CondTy &C, const LTy &TrueC, const RTy &FalseC)
Matches a value that behaves like a boolean-controlled select, i.e.
BinaryOp_match< LHS, RHS, Instruction::Add, true > m_c_Add(const LHS &L, const RHS &R)
Matches a Add with LHS and RHS in either order.
auto m_Intrinsic(const Ts &...Ops)
Match intrinsic calls like this: m_Intrinsic<Intrinsic::fabs>(m_Value(X))
CmpClass_match< LHS, RHS, ICmpInst > m_ICmp(CmpPredicate &Pred, const LHS &L, const RHS &R)
match_combine_or< CastInst_match< OpTy, ZExtInst >, CastInst_match< OpTy, SExtInst > > m_ZExtOrSExt(const OpTy &Op)
FNeg_match< OpTy > m_FNeg(const OpTy &X)
Match 'fneg X' as 'fsub -0.0, X'.
BinaryOp_match< LHS, RHS, Instruction::FAdd, true > m_c_FAdd(const LHS &L, const RHS &R)
Matches FAdd with LHS and RHS in either order.
LogicalOp_match< LHS, RHS, Instruction::And, true > m_c_LogicalAnd(const LHS &L, const RHS &R)
Matches L && R with LHS and RHS in either order.
auto m_LogicalAnd()
Matches L && R where L and R are arbitrary values.
CastInst_match< OpTy, SExtInst > m_SExt(const OpTy &Op)
Matches SExt.
BinaryOp_match< LHS, RHS, Instruction::Mul, true > m_c_Mul(const LHS &L, const RHS &R)
Matches a Mul with LHS and RHS in either order.
BinaryOp_match< LHS, RHS, Instruction::Sub > m_Sub(const LHS &L, const RHS &R)
auto m_ConstantInt()
Match an arbitrary ConstantInt and ignore it.
bind_cst_ty m_scev_APInt(const APInt *&C)
Match an SCEV constant and bind it to an APInt.
specificloop_ty m_SpecificLoop(const Loop *L)
bool match(const SCEV *S, const Pattern &P)
SCEVAffineAddRec_match< Op0_t, Op1_t, match_isa< const Loop > > m_scev_AffineAddRec(const Op0_t &Op0, const Op1_t &Op1)
VPInstruction_match< VPInstruction::ExtractLastLane, VPInstruction_match< VPInstruction::ExtractLastPart, Op0_t > > m_ExtractLastLaneOfLastPart(const Op0_t &Op0)
AllRecipe_commutative_match< Instruction::And, Op0_t, Op1_t > m_c_BinaryAnd(const Op0_t &Op0, const Op1_t &Op1)
Match a binary AND operation.
AllRecipe_match< Instruction::Or, Op0_t, Op1_t > m_BinaryOr(const Op0_t &Op0, const Op1_t &Op1)
Match a binary OR operation.
VPInstruction_match< VPInstruction::AnyOf > m_AnyOf()
AllRecipe_commutative_match< Instruction::Or, Op0_t, Op1_t > m_c_BinaryOr(const Op0_t &Op0, const Op1_t &Op1)
VPInstruction_match< VPInstruction::ComputeReductionResult, Op0_t > m_ComputeReductionResult(const Op0_t &Op0)
auto m_WidenAnyExtend(const Op0_t &Op0)
match_bind< VPIRValue > m_VPIRValue(VPIRValue *&V)
Match a VPIRValue.
VPInstruction_match< VPInstruction::WideActiveLaneMask, Op0_t, Op1_t, Op2_t > m_WideActiveLaneMask(const Op0_t &Op0, const Op1_t &Op1, const Op2_t &Op2)
auto m_VPPhi(const Op0_t &Op0, const Op1_t &Op1)
VPInstruction_match< VPInstruction::BranchOnTwoConds > m_BranchOnTwoConds()
AllRecipe_match< Opcode, Op0_t, Op1_t > m_Binary(const Op0_t &Op0, const Op1_t &Op1)
VPInstruction_match< VPInstruction::LastActiveLane, Op0_t > m_LastActiveLane(const Op0_t &Op0)
auto m_WidenIntrinsic(const T &...Ops)
canonical_widen_iv_match m_CanonicalWidenIV()
VPInstruction_match< VPInstruction::ExitingIVValue, Op0_t > m_ExitingIVValue(const Op0_t &Op0)
VPInstruction_match< Instruction::ExtractElement, Op0_t, Op1_t > m_ExtractElement(const Op0_t &Op0, const Op1_t &Op1)
specific_intval< 1 > m_False()
VPInstruction_match< VPInstruction::ExtractLastLane, Op0_t > m_ExtractLastLane(const Op0_t &Op0)
match_bind< VPSingleDefRecipe > m_VPSingleDefRecipe(VPSingleDefRecipe *&V)
Match a VPSingleDefRecipe, capturing if we match.
VPInstruction_match< VPInstruction::BranchOnCount > m_BranchOnCount()
auto m_GetElementPtr(const Op0_t &Op0, const Op1_t &Op1)
specific_intval< 1 > m_True()
auto m_VPValue()
Match an arbitrary VPValue and ignore it.
VPInstruction_match< VPInstruction::ExtractVectorForPart, Op0_t, Op1_t > m_ExtractVectorForPart(const Op0_t &Op0, const Op1_t &Op1)
VPInstruction_match< VPInstruction::ExtractLastPart, Op0_t > m_ExtractLastPart(const Op0_t &Op0)
VPRecipeBase * findUserOf(VPValue *V, const MatchT &P)
If V is used by a recipe matching pattern P, return it.
VPInstruction_match< VPInstruction::Broadcast, Op0_t > m_Broadcast(const Op0_t &Op0)
header_mask_match m_HeaderMask()
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::ExtractPenultimateElement, Op0_t > m_ExtractPenultimateElement(const Op0_t &Op0)
match_bind< VPInstruction > m_VPInstruction(VPInstruction *&V)
Match a VPInstruction, capturing if we match.
VPInstruction_match< VPInstruction::FirstActiveLane, Op0_t > m_FirstActiveLane(const Op0_t &Op0)
auto m_DerivedIV(const Op0_t &Op0, const Op1_t &Op1, const Op2_t &Op2)
VPInstruction_match< VPInstruction::BranchOnCond > m_BranchOnCond()
VPInstruction_match< VPInstruction::ExtractLane, Op0_t, Op1_t > m_ExtractLane(const Op0_t &Op0, const Op1_t &Op1)
auto m_AnyNeg(const Op0_t &Op0)
VPInstruction_match< VPInstruction::Reverse, Op0_t > m_Reverse(const Op0_t &Op0)
NodeAddr< DefNode * > Def
Definition RDFGraph.h:384
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...
VPValue * getOrCreateVPValueForSCEVExpr(VPlan &Plan, const SCEV *Expr)
Get or create a VPValue that corresponds to the expansion of Expr.
bool cannotHoistOrSinkRecipe(const VPRecipeBase &R, bool Sinking=false)
Return true if we do not know how to (mechanically) hoist or sink R.
unsigned getOpcode(const VPValue *V)
Return the instruction opcode for the recipe defining V or 0 for unsupported recipes and VPValues not...
VPInstruction * findComputeReductionResult(VPReductionPHIRecipe *PhiR)
Find the ComputeReductionResult recipe for PhiR, looking through selects inserted for predicated redu...
VPInstruction * findCanonicalIVIncrement(VPlan &Plan)
Find the canonical IV increment of Plan's vector loop region.
std::optional< MemoryLocation > getMemoryLocation(const VPRecipeBase &R)
Return a MemoryLocation for R with noalias metadata populated from R, if the recipe is supported and ...
bool onlyFirstLaneUsed(const VPValue *Def)
Returns true if only the first lane of Def is used.
VPIRValue * tryToFoldLiveIns(VPSingleDefRecipe &R, ArrayRef< VPValue * > Operands, const DataLayout &DL)
Try to fold R using InstSimplifyFolder.
SmallVector< std::pair< VPBasicBlock *, VPIRBasicBlock * > > getEarlyExits(const VPlan &Plan, const VPBlockBase *MiddleVPBB)
Returns the (early exiting block, exit block) pairs of Plan, i.e.
void recursivelyDeleteDeadRecipes(VPValue *V)
Recursively delete V and any of its operands that become dead.
bool doesGeneratePerAllLanes(const VPRecipeBase *R)
Returns true if R produces scalar values for all VF lanes.
bool isDeadRecipe(VPRecipeBase &R)
Returns true if R is dead, i.e.
VPRecipeBase * findRecipe(VPValue *Start, PredT Pred)
Search Start's users for a recipe satisfying Pred, looking through recipes with definitions.
Definition VPlanUtils.h:149
bool isUniformAcrossVFsAndUFs(const VPValue *V)
Checks if V is uniform across all VF lanes and UF parts.
bool isUsedByLoadStoreAddress(const VPValue *V)
Returns true if V is used as part of the address of another load or store.
std::optional< std::pair< bool, unsigned > > getOpcodeOrIntrinsicID(const VPValue *V)
Get the instruction opcode or intrinsic ID for the recipe defining V.
VPValue * scalarizeVPWidenPointerInduction(VPWidenPointerInductionRecipe *PtrIV, VPlan &Plan, VPBuilder &Builder)
Scalarize a VPWidenPointerInductionRecipe by replacing it with a PtrAdd (IndStart,...
const SCEV * getSCEVExprForVPValue(const VPValue *V, PredicatedScalarEvolution &PSE, const Loop *L=nullptr)
Return the SCEV expression for V.
void pullOutPermutations(VPlan &Plan, Match_t Perm, Builder Build)
Removes the permutation pattern Perm from any elementwise operations in the plan, by constructing a n...
Definition VPlanUtils.h:236
SmallVector< VPUser * > collectUsersRecursively(VPValue *V)
Collect all users of V, looking through recipes that define other values.
VPScalarIVStepsRecipe * createScalarIVSteps(VPlan &Plan, InductionDescriptor::InductionKind Kind, Instruction::BinaryOps InductionOpcode, FPMathOperator *FPBinOp, Instruction *TruncI, VPIRValue *StartV, VPValue *Step, DebugLoc DL, VPBuilder &Builder, const VPIRFlags::WrapFlagsTy &Flags={})
Create a scalar-iv-steps recipe over Plan's canonical IV for an induction of Kind with InductionOpcod...
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:315
SmallVector< VPBasicBlock * > vp_rpo_plain_cfg_loop_body(VPBasicBlock *Header)
Returns the VPBasicBlocks forming the loop body of a plain (pre-region) VPlan in reverse post-order s...
Definition VPlanCFG.h:262
@ Offset
Definition DWP.cpp:578
void stable_sort(R &&Range)
Definition STLExtras.h:2116
auto min_element(R &&Range)
Provide wrappers to std::min_element which take ranges instead of having to pass begin/end explicitly...
Definition STLExtras.h:2078
bool all_of(R &&range, UnaryPredicate P)
Provide wrappers to std::all_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1739
unsigned getLoadStoreAddressSpace(const Value *I)
A helper function that returns the address space of the pointer operand of load or store instruction.
auto size(R &&Range, std::enable_if_t< std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< decltype(Range.begin())>::iterator_category >::value, void > *=nullptr)
Get the size of a range.
Definition STLExtras.h:1669
LLVM_ABI Intrinsic::ID getVectorIntrinsicIDForCall(const CallInst *CI, const TargetLibraryInfo *TLI)
Returns intrinsic ID for call.
detail::zippy< detail::zip_first, T, U, Args... > zip_equal(T &&t, U &&u, Args &&...args)
zip iterator that assumes that all iteratees have the same length.
Definition STLExtras.h:840
DenseMap< const Value *, const SCEV * > ValueToSCEVMapTy
auto enumerate(FirstRange &&First, RestRanges &&...Rest)
Given two or more input ranges, returns a new range whose values are tuples (A, B,...
Definition STLExtras.h:2554
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
const Value * getLoadStorePointerOperand(const Value *V)
A helper function that returns the pointer operand of a load or store instruction.
@ Load
The value being inserted comes from a load (InsertElement only).
@ Store
The extracted value is stored (ExtractElement only).
constexpr from_range_t from_range
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
Definition STLExtras.h:2208
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:633
auto cast_or_null(const Y &Val)
Definition Casting.h:714
Align getLoadStoreAlignment(const Value *I)
A helper function that returns the alignment of load or store instruction.
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:250
constexpr auto bind_back(FnT &&Fn, BindArgsT &&...BindArgs)
C++23 bind_back.
bool isa_and_nonnull(const Y &Val)
Definition Casting.h:676
iterator_range< df_iterator< VPBlockDeepTraversalWrapper< VPBlockBase * > > > vp_depth_first_deep(VPBlockBase *G)
Returns an iterator range to traverse the graph starting at G in depth-first order while traversing t...
Definition VPlanCFG.h:285
constexpr auto equal_to(T &&Arg)
Functor variant of std::equal_to that can be used as a UnaryPredicate in functional algorithms like a...
Definition STLExtras.h:2173
bool operator==(const AddressRangeValuePair &LHS, const AddressRangeValuePair &RHS)
auto map_range(ContainerTy &&C, FuncTy F)
Return a range that applies F to the elements of C.
Definition STLExtras.h:365
uint64_t PowerOf2Ceil(uint64_t A)
Returns the power of two which is greater than or equal to the given value.
Definition MathExtras.h:380
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
void erase(Container &C, ValueType V)
Wrapper function to remove a value from a container:
Definition STLExtras.h:2200
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:1746
auto reverse(ContainerTy &&C)
Definition STLExtras.h:407
constexpr size_t range_size(R &&Range)
Returns the size of the Range, i.e., the number of elements.
Definition STLExtras.h:1694
void sort(IteratorTy Start, IteratorTy End)
Definition STLExtras.h:1636
bool hasIrregularType(Type *Ty, const DataLayout &DL)
A helper function that returns true if the given type is irregular.
UncountableExitStyle
Different methods of handling early exits.
Definition VPlan.h:79
@ ReadOnly
No side effects to worry about, so we can process any uncountable exits in the loop and branch either...
Definition VPlan.h:83
@ MaskedHandleExitInScalarLoop
All memory operations other than the load(s) required to determine whether an uncountable exit occurr...
Definition VPlan.h:88
bool none_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::none_of which take ranges instead of having to pass begin/end explicitly.
Definition STLExtras.h:1753
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...
iterator_range< filter_iterator< detail::IterOfRange< RangeT >, PredicateT > > make_filter_range(RangeT &&Range, PredicateT Pred)
Convenience function that takes a range of elements and a predicate, and return a new filter_iterator...
Definition STLExtras.h:551
bool canConstantBeExtended(const APInt *C, Type *NarrowType, TTI::PartialReductionExtendKind ExtKind)
Check if a constant CI can be safely treated as having been extended from a narrower type with the gi...
Definition VPlan.cpp:1884
T * find_singleton(R &&Range, Predicate P, bool AllowRepeats=false)
Return the single value in Range that satisfies P(<member of Range> *, AllowRepeats)->T * returning n...
Definition STLExtras.h:1837
class LLVM_GSL_OWNER SmallVector
Forward declaration of SmallVector so that calculateSmallVectorDefaultInlinedElements can reference s...
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:547
auto drop_end(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the last N elements excluded.
Definition STLExtras.h:322
@ Other
Any other memory.
Definition ModRef.h:68
TargetTransformInfo TTI
RecurKind
These are the kinds of recurrences that we support.
@ UMin
Unsigned integer min implemented in terms of select(cmp()).
@ FindIV
FindIV reduction with select(icmp(),x,y) where one of (x,y) is a loop induction variable (increasing ...
@ Or
Bitwise or logical OR of integers.
@ Mul
Product of integers.
@ FSub
Subtraction of floats.
@ FMul
Product of floats.
@ SMax
Signed integer max implemented in terms of select(cmp()).
@ SMin
Signed integer min implemented in terms of select(cmp()).
@ Sub
Subtraction of integers.
@ Add
Sum of integers.
@ AddChainWithSubs
A chain of adds and subs.
@ FAdd
Sum of floats.
@ UMax
Unsigned integer max implemented in terms of select(cmp()).
LLVM_ABI Value * getRecurrenceIdentity(RecurKind K, Type *Tp, FastMathFlags FMF)
Given information about an recurrence kind, return the identity for the @llvm.vector....
LLVM_ABI BasicBlock * SplitBlock(BasicBlock *Old, BasicBlock::iterator SplitPt, DominatorTree *DT, LoopInfo *LI=nullptr, MemorySSAUpdater *MSSAU=nullptr, const Twine &BBName="")
Split the specified block at the specified instruction.
auto count(R &&Range, const E &Element)
Wrapper function around std::count to count the number of times an element Element occurs in the give...
Definition STLExtras.h:2012
DWARFExpression::Operation Op
auto max_element(R &&Range)
Provide wrappers to std::max_element which take ranges instead of having to pass begin/end explicitly...
Definition STLExtras.h:2088
ArrayRef(const T &OneElt) -> ArrayRef< T >
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
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:1772
bool is_contained(R &&Range, const E &Element)
Returns true if Element is found in Range.
Definition STLExtras.h:1947
Type * getLoadStoreType(const Value *I)
A helper function that returns the type of a load or store instruction.
bool all_equal(std::initializer_list< T > Values)
Returns true if all Values in the initializer lists are equal or the list.
Definition STLExtras.h:2166
hash_code hash_combine(const Ts &...args)
Combine values into a single hash_code.
Definition Hashing.h:305
LLVM_ABI std::optional< int64_t > getStrideFromAddRec(const SCEVAddRecExpr *AR, const Loop *Lp, Type *AccessTy, Value *Ptr, PredicatedScalarEvolution &PSE)
If AR is an affine AddRec for Lp with a constant step, return the step in units of AccessTy's allocat...
bool equal(L &&LRange, R &&RRange)
Wrapper function around std::equal to detect if pair-wise elements between two ranges are the same.
Definition STLExtras.h:2146
Type * toVectorTy(Type *Scalar, ElementCount EC)
A helper function for converting Scalar types to vector types.
LLVM_ABI bool isDereferenceableAndAlignedInLoop(LoadInst *LI, Loop *L, ScalarEvolution &SE, DominatorTree &DT, AssumptionCache *AC=nullptr, SmallVectorImpl< const SCEVPredicate * > *Predicates=nullptr)
Return true if we can prove that the given load (which is assumed to be within the specified loop) wo...
Definition Loads.cpp:304
constexpr detail::IsaCheckPredicate< Types... > IsaPred
Function object wrapper for the llvm::isa type check.
Definition Casting.h:866
hash_code hash_combine_range(InputIteratorT first, InputIteratorT last)
Compute a hash_code for a sequence of values.
Definition Hashing.h:285
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.
Definition BitVector.h:880
#define N
VPBasicBlock * EarlyExitingVPBB
VPIRBasicBlock * EarlyExitVPBB
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition Alignment.h:39
An information struct used to provide DenseMap with the various necessary components for a given valu...
This reduction is unordered with the partial result scaled down by some factor.
Definition VPlan.h:2852
Holds the VFShape for a specific scalar to vector function mapping.
Encapsulates information needed to describe a parameter.
A range of powers-of-2 vectorization factors with fixed start and adjustable end.
Struct to hold various analysis needed for cost computations.
const VFSelectionContext & Config
static bool isFreeScalarIntrinsic(Intrinsic::ID ID)
Returns true if ID is a pseudo intrinsic that is dropped via scalarization rather than widened.
Definition VPlan.cpp:1990
bool isMaskRequired(Instruction *I) const
Forwards to LoopVectorizationCostModel::isMaskRequired.
PredicatedScalarEvolution & PSE
bool willBeScalarized(Instruction *I, ElementCount VF) const
Returns true if I is known to be scalarized at VF.
TargetTransformInfo::TargetCostKind CostKind
const TargetLibraryInfo & TLI
const TargetTransformInfo & TTI
A VPValue representing a live-in from the input IR or a constant.
Definition VPlanValue.h:279
Type * getType() const
Returns the type of the underlying IR value.
Definition VPlan.cpp:147
A recipe for widening load operations, using the address to load from and an optional mask.
Definition VPlan.h:3819
A recipe for widening store operations, using the stored value, the address to store to and an option...
Definition VPlan.h:3918
static void simplifyLiveInsWithSCEV(VPlan &Plan, PredicatedScalarEvolution &PSE)
Check Plan's live-ins and replace them with constants, if they can be simplified via SCEV.
static decltype(auto) runPass(StringRef PassName, PassTy &&Pass, VPlan &Plan, ArgsTy &&...Args)
Helper to run a VPlan pass Pass on VPlan, forwarding extra arguments to the pass.
static void createInterleaveGroups(VPlan &Plan, const SmallPtrSetImpl< const InterleaveGroup< Instruction > * > &InterleaveGroups, const bool &EpilogueAllowed)
static LLVM_ABI_FOR_TEST bool tryToConvertVPInstructionsToVPRecipes(VPlan &Plan, const TargetLibraryInfo &TLI, PredicatedScalarEvolution &PSE, Loop *OuterLoop)
Replaces the VPInstructions in Plan with corresponding widen recipes.
static void createAndOptimizeReplicateRegions(VPlan &Plan)
Wrap predicated VPReplicateRecipes with a mask operand in an if-then region block and remove the mask...
static std::unique_ptr< VPlan > narrowInterleaveGroups(VPlan &Plan, const TargetTransformInfo &TTI)
Try to find a single VF among Plan's VFs for which all interleave groups (with known minimum VF eleme...
static void makeMemOpWideningDecisions(VPlan &Plan, VFRange &Range, VPRecipeBuilder &RecipeBuilder, VPCostContext &CostCtx)
Convert load/store VPInstructions in Plan into widened or replicate recipes.
static LLVM_ABI_FOR_TEST bool handleUncountableEarlyExits(VPlan &Plan, Loop *TheLoop, PredicatedScalarEvolution &PSE, DominatorTree &DT, AssumptionCache *AC, UncountableExitStyle Style)
Update Plan to account for uncountable early exits by introducing appropriate branching logic in the ...
static void hoistPredicatedLoads(VPlan &Plan, PredicatedScalarEvolution &PSE, const Loop *L)
Hoist predicated loads from the same address to the loop entry block, if they are guaranteed to execu...
static bool mergeBlocksIntoPredecessors(VPlan &Plan)
Remove redundant VPBasicBlocks by merging them into their single predecessor if the latter has a sing...
static void optimizeFindIVReductions(VPlan &Plan, PredicatedScalarEvolution &PSE, Loop &L)
Optimize FindLast reductions selecting IVs (or expressions of IVs) by converting them to FindIV reduc...
static void convertToAbstractRecipes(VPlan &Plan, VPCostContext &Ctx, VFRange &Range)
This function converts initial recipes to the abstract recipes and clamps Range based on cost model f...
static void makeScalarizationDecisions(VPlan &Plan, VFRange &Range)
Make VPlan-based scalarization decision prior to delegating to the ones made by the legacy CM.
static bool areAllLoadsDereferenceable(VPBasicBlock *HeaderVPBB, Loop *TheLoop, PredicatedScalarEvolution &PSE, DominatorTree &DT, AssumptionCache *AC)
Check if all loads in the loop are dereferenceable.
static void optimizeInductionLiveOutUsers(VPlan &Plan, PredicatedScalarEvolution &PSE, const Loop *L)
If there's a single exit block, optimize its phi recipes that use exiting IV values by feeding them p...
static void simplifyReverses(VPlan &Plan)
Cancel out redundant reverses in Plan, e.g. reverse(reverse(x)) -> x.
static void makeCallWideningDecisions(VPlan &Plan, VFRange &Range, VPRecipeBuilder &RecipeBuilder, VPCostContext &CostCtx)
Convert call VPInstructions in Plan into widened call, vector intrinsic or replicate recipes based on...
static void adjustFirstOrderRecurrenceMiddleUsers(VPlan &Plan, VFRange &Range)
Adjust first-order recurrence users in the middle block: create penultimate element extracts for LCSS...
static void removeDeadRecipes(VPlan &Plan)
Remove dead recipes from Plan.
static void simplifyRecipes(VPlan &Plan)
Perform instcombine-like simplifications on recipes in Plan.
static void sinkPredicatedStores(VPlan &Plan, PredicatedScalarEvolution &PSE, const Loop *L)
Sink predicated stores to the same address with complementary predicates (P and NOT P) to an uncondit...
static void replaceSymbolicStrides(VPlan &Plan, PredicatedScalarEvolution &PSE, const DenseMap< Value *, const SCEV * > &StridesMap, const VPDominatorTree &VPDT)
Replace symbolic strides from StridesMap in Plan with constants when possible.
static bool removeBranchOnConst(VPlan &Plan, bool OnlyLatches=false)
Remove BranchOnCond recipes with true or false conditions together with removing dead edges to their ...
static void convertToStridedAccesses(VPlan &Plan, PredicatedScalarEvolution &PSE, Loop &L, VPCostContext &Ctx, VFRange &Range)
Transform widen memory recipes into strided access recipes when legal and profitable.
static void clearReductionWrapFlags(VPlan &Plan)
Clear NSW/NUW flags from reduction instructions if necessary.
static void createPartialReductions(VPlan &Plan, VPCostContext &CostCtx, VFRange &Range)
Detect and create partial reduction recipes for scaled reductions in Plan.
static void cse(VPlan &Plan)
Perform common-subexpression-elimination on Plan.
static LLVM_ABI_FOR_TEST void optimize(VPlan &Plan)
Apply VPlan-to-VPlan optimizations to Plan, including induction recipe optimizations,...
static void truncateToMinimalBitwidths(VPlan &Plan, const MapVector< Instruction *, uint64_t > &MinBWs)
Insert truncates and extends for any truncated recipe.
static void dropPoisonGeneratingRecipes(VPlan &Plan)
Drop poison flags from recipes that may generate a poison value that is used after vectorization,...
static void optimizeForVFAndUF(VPlan &Plan, ElementCount BestVF, unsigned BestUF, PredicatedScalarEvolution &PSE)
Optimize Plan based on BestVF and BestUF.