LLVM 24.0.0git
LoopAccessAnalysis.cpp
Go to the documentation of this file.
1//===- LoopAccessAnalysis.cpp - Loop Access Analysis Implementation --------==//
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// The implementation for the loop memory dependence that was originally
10// developed for the loop vectorizer.
11//
12//===----------------------------------------------------------------------===//
13
15#include "llvm/ADT/APInt.h"
16#include "llvm/ADT/DenseMap.h"
19#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/SetVector.h"
22#include "llvm/ADT/SmallSet.h"
40#include "llvm/IR/BasicBlock.h"
41#include "llvm/IR/Constants.h"
42#include "llvm/IR/DataLayout.h"
43#include "llvm/IR/DebugLoc.h"
46#include "llvm/IR/Dominators.h"
47#include "llvm/IR/Function.h"
48#include "llvm/IR/InstrTypes.h"
49#include "llvm/IR/Instruction.h"
52#include "llvm/IR/PassManager.h"
53#include "llvm/IR/Type.h"
54#include "llvm/IR/Value.h"
55#include "llvm/IR/ValueHandle.h"
58#include "llvm/Support/Debug.h"
62#include <algorithm>
63#include <cassert>
64#include <cstdint>
65#include <iterator>
66#include <utility>
67#include <variant>
68#include <vector>
69
70using namespace llvm;
71using namespace llvm::SCEVPatternMatch;
72
73#define DEBUG_TYPE "loop-accesses"
74
76 VectorizationFactor("force-vector-width", cl::Hidden,
77 cl::desc("Sets the SIMD width. Zero is autoselect."),
80
82VectorizationInterleave("force-vector-interleave", cl::Hidden,
83 cl::desc("Sets the vectorization interleave count. "
84 "Zero is autoselect."),
88
90 "runtime-memory-check-threshold", cl::Hidden,
91 cl::desc("When performing memory disambiguation checks at runtime do not "
92 "generate more than this number of comparisons (default = 8)."),
95
96/// The maximum iterations used to merge memory checks
98 "memory-check-merge-threshold", cl::Hidden,
99 cl::desc("Maximum number of comparisons done when trying to merge "
100 "runtime memory checks. (default = 100)"),
101 cl::init(100));
102
103/// Maximum SIMD width.
104const unsigned VectorizerParams::MaxVectorWidth = 64;
105
106/// We collect dependences up to this threshold.
108 MaxDependences("max-dependences", cl::Hidden,
109 cl::desc("Maximum number of dependences collected by "
110 "loop-access analysis (default = 100)"),
111 cl::init(100));
112
113/// This enables versioning on the strides of symbolically striding memory
114/// accesses in code like the following.
115/// for (i = 0; i < N; ++i)
116/// A[i * Stride1] += B[i * Stride2] ...
117///
118/// Will be roughly translated to
119/// if (Stride1 == 1 && Stride2 == 1) {
120/// for (i = 0; i < N; i+=4)
121/// A[i:i+3] += ...
122/// } else
123/// ...
125 "enable-mem-access-versioning", cl::init(true), cl::Hidden,
126 cl::desc("Enable symbolic stride memory access versioning"));
127
128/// Enable store-to-load forwarding conflict detection. This option can
129/// be disabled for correctness testing.
131 "store-to-load-forwarding-conflict-detection", cl::Hidden,
132 cl::desc("Enable conflict detection in loop-access analysis"),
133 cl::init(true));
134
136 "max-forked-scev-depth", cl::Hidden,
137 cl::desc("Maximum recursion depth when finding forked SCEVs (default = 5)"),
138 cl::init(5));
139
141 "laa-speculate-unit-stride", cl::Hidden,
142 cl::desc("Speculate that non-constant strides are unit in LAA"),
143 cl::init(true));
144
146 "hoist-runtime-checks", cl::Hidden,
147 cl::desc(
148 "Hoist inner loop runtime memory checks to outer loop if possible"),
151
153 return ::VectorizationInterleave.getNumOccurrences() > 0;
154}
155
156const SCEV *
158 const SymbolicStrideMap &PtrToStride,
159 Value *Ptr) {
160 const SCEV *OrigSCEV = PSE.getSCEV(Ptr);
161
162 // If there is an entry in the map return the SCEV of the pointer with the
163 // symbolic stride replaced by one.
164 const SCEVUnknown *StrideSCEV = PtrToStride.lookup(Ptr);
165 if (!StrideSCEV)
166 // For a non-symbolic stride, just return the original expression.
167 return OrigSCEV;
168
169 ScalarEvolution *SE = PSE.getSE();
170 const SCEV *CT = SE->getOne(StrideSCEV->getType());
171 PSE.addPredicate(*SE->getEqualPredicate(StrideSCEV, CT));
172 const SCEV *Expr = PSE.getSCEV(Ptr);
173
174 LLVM_DEBUG(dbgs() << "LAA: Replacing SCEV: " << *OrigSCEV
175 << " by: " << *Expr << "\n");
176 return Expr;
177}
178
180 unsigned Index, const RuntimePointerChecking &RtCheck)
181 : High(RtCheck.Pointers[Index].End), Low(RtCheck.Pointers[Index].Start),
182 AddressSpace(RtCheck.Pointers[Index]
183 .PointerValue->getType()
185 NeedsFreeze(RtCheck.Pointers[Index].NeedsFreeze) {
186 Members.push_back(Index);
187}
188
189/// Returns \p A + \p B, if it is guaranteed not to unsigned wrap. Otherwise
190/// return nullptr. \p A and \p B must have the same type.
191static const SCEV *addSCEVNoOverflow(const SCEV *A, const SCEV *B,
192 ScalarEvolution &SE) {
193 if (!SE.willNotOverflow(Instruction::Add, /*IsSigned=*/false, A, B))
194 return nullptr;
195 return SE.getAddExpr(A, B);
196}
197
198/// Returns \p A * \p B, if it is guaranteed not to unsigned wrap. Otherwise
199/// return nullptr. \p A and \p B must have the same type.
200static const SCEV *mulSCEVNoOverflow(const SCEV *A, const SCEV *B,
201 ScalarEvolution &SE) {
202 if (!SE.willNotOverflow(Instruction::Mul, /*IsSigned=*/false, A, B))
203 return nullptr;
204 return SE.getMulExpr(A, B);
205}
206
207/// Return true, if evaluating \p AR at \p MaxBTC cannot wrap, because \p AR at
208/// \p MaxBTC is guaranteed inbounds of the accessed object.
210 const SCEVAddRecExpr *AR, const SCEV *MaxBTC, const SCEV *EltSize,
212 AssumptionCache *AC,
213 std::optional<ScalarEvolution::LoopGuards> &LoopGuards) {
214 auto *PointerBase = SE.getPointerBase(AR->getStart());
215 auto *StartPtr = dyn_cast<SCEVUnknown>(PointerBase);
216 if (!StartPtr)
217 return false;
218 const Loop *L = AR->getLoop();
219 bool CheckForNonNull;
220 Value *StartPtrV = StartPtr->getValue();
221 // We can ignore frees, as the fact that an object of a certain size existed
222 // at the location *at some point* is sufficient to derive the nowrap fact.
223 uint64_t DerefBytes = StartPtrV->getPointerDereferenceableBytes(
224 DL, CheckForNonNull, /*CanBeFreed=*/nullptr);
225
226 // If the deref size is only known when the pointer is non-null, ignore it
227 // here and fall back to a dereferenceable assumption below.
228 if (DerefBytes && CheckForNonNull)
229 DerefBytes = 0;
230
231 const SCEV *Step = AR->getStepRecurrence(SE);
232 Type *WiderTy = SE.getWiderType(MaxBTC->getType(), Step->getType());
233 const SCEV *DerefBytesSCEV = SE.getConstant(WiderTy, DerefBytes);
234
235 // Check if we have a suitable dereferencable assumption we can use.
236 Instruction *CtxI = &*L->getHeader()->getFirstNonPHIIt();
237 if (BasicBlock *LoopPred = L->getLoopPredecessor()) {
238 if (isa<UncondBrInst, CondBrInst>(LoopPred->getTerminator()))
239 CtxI = LoopPred->getTerminator();
240 }
242 StartPtrV, Attribute::Dereferenceable, *AC,
243 [&](RetainedKnowledge RK, Instruction *Assume, auto) {
244 if (!isValidAssumeForContext(Assume, CtxI, DT))
245 return false;
246 const SCEV *DerefRKSCEV = SE.getSCEV(RK.IRArgValue);
247 Type *CommonTy =
248 SE.getWiderType(DerefBytesSCEV->getType(), DerefRKSCEV->getType());
249 DerefBytesSCEV = SE.getNoopOrZeroExtend(DerefBytesSCEV, CommonTy);
250 DerefRKSCEV = SE.getNoopOrZeroExtend(DerefRKSCEV, CommonTy);
251 DerefBytesSCEV = SE.getUMaxExpr(DerefBytesSCEV, DerefRKSCEV);
252 // Continue with other assumptions.
253 return false;
254 });
255
256 if (DerefBytesSCEV->isZero())
257 return false;
258
259 bool IsKnownNonNegative = SE.isKnownNonNegative(Step);
260 if (!IsKnownNonNegative && !SE.isKnownNegative(Step))
261 return false;
262
263 WiderTy = SE.getWiderType(WiderTy, DerefBytesSCEV->getType());
264 Step = SE.getNoopOrSignExtend(Step, WiderTy);
265 MaxBTC = SE.getNoopOrZeroExtend(MaxBTC, WiderTy);
266
267 // For the computations below, make sure they don't unsigned wrap.
268 // FIXME: for a negative step the lowest accessed address is not
269 // AR->getStart() but AR->evaluateAtIteration(MaxBTC, SE); the check below
270 // therefore compares StartPtr against the highest accessed address instead
271 // of the lowest.
272 if (!SE.isKnownPredicate(CmpInst::ICMP_UGE, AR->getStart(), StartPtr))
273 return false;
274 const SCEV *StartOffset = SE.getNoopOrZeroExtend(
275 SE.getMinusSCEV(AR->getStart(), StartPtr), WiderTy);
276
277 if (!LoopGuards)
278 LoopGuards.emplace(ScalarEvolution::LoopGuards::collect(AR->getLoop(), SE));
279 MaxBTC = SE.applyLoopGuards(MaxBTC, *LoopGuards);
280
281 const SCEV *AbsStep = SE.getAbsExpr(Step, /*IsNSW=*/false);
282 // Total distance (in bytes) between the first and the last
283 // accessed pointer.
284 const SCEV *DistToLastIter = mulSCEVNoOverflow(MaxBTC, AbsStep, SE);
285 if (!DistToLastIter) {
286 // Re-try with constant max backedge-taken count if using the symbolic one
287 // failed.
288 MaxBTC = SE.getConstantMaxBackedgeTakenCount(AR->getLoop());
289 if (isa<SCEVCouldNotCompute>(MaxBTC))
290 return false;
291 MaxBTC = SE.getNoopOrZeroExtend(MaxBTC, WiderTy);
292 DistToLastIter = mulSCEVNoOverflow(MaxBTC, AbsStep, SE);
293 if (!DistToLastIter)
294 return false;
295 }
296
297 // Total length in bytes of the accessed range (from the first accessed
298 // byte through the end of the last access).
299 const SCEV *AccessedBytes = addSCEVNoOverflow(
300 DistToLastIter, SE.getNoopOrZeroExtend(EltSize, WiderTy), SE);
301 if (!AccessedBytes)
302 return false;
303
304 // Compute MaxOffset per direction: exclusive upper offset of the
305 // accessed range.
306 const SCEV *MaxOffset;
307 if (IsKnownNonNegative) {
308 MaxOffset = addSCEVNoOverflow(StartOffset, AccessedBytes, SE);
309 if (!MaxOffset)
310 return false;
311 DerefBytesSCEV = SE.applyLoopGuards(DerefBytesSCEV, *LoopGuards);
312 } else {
313 // FIXME: two independent off-by-EltSize bugs on this branch:
314 // 1. StartOffset here is actually the HIGHEST offset, because it is
315 // computed from AR->getStart() rather than
316 // AR->evaluateAtIteration(MaxBTC, SE) (see FIXME above).
317 // 2. The lower check is over-strict by EltSize and the upper is
318 // under-counted by EltSize.
319 assert(SE.isKnownNegative(Step) && "must be known negative");
320 if (!SE.isKnownPredicate(CmpInst::ICMP_SGE, StartOffset, AccessedBytes))
321 return false;
322 MaxOffset = StartOffset;
323 }
324 // MaxOffset must not exceed the deref-region end.
325 return SE.isKnownPredicate(CmpInst::ICMP_ULE, MaxOffset, DerefBytesSCEV);
326}
327
328/// Return true if \p S is known to be monotonically non-decreasing
329/// (in the unsigned sense, without unsigned wrap) across iterations of \p L.
330static bool isKnownNonDecreasingInLoop(const SCEV *S, const Loop *L,
331 ScalarEvolution &SE) {
332 if (SE.isLoopInvariant(S, L))
333 return true;
334
335 switch (S->getSCEVType()) {
336 case scUDivExpr: {
337 // Non-decreasing in the numerator when the divisor is loop-invariant.
338 const auto *UDiv = cast<SCEVUDivExpr>(S);
339 return SE.isLoopInvariant(UDiv->getRHS(), L) &&
340 isKnownNonDecreasingInLoop(UDiv->getLHS(), L, SE);
341 }
342 case scAddRecExpr: {
343 auto *AR = cast<SCEVAddRecExpr>(S);
344 assert(AR->getLoop() == L &&
345 "trying to check for AddRec in different loop");
348 }
349 default:
350 return false;
351 }
352}
353
354/// Try to bound a loop-variant pointer that is not an affine AddRec.
355///
356/// If the offset is provably monotonically non-decreasing the accessed range is
357/// bounded by the offset's value at the first iteration (via
358/// SplitIntoInitAndPostInc) and last iteration (via getSCEVAtScope)
359///
360/// Returns {nullptr, nullptr} if no such bound can be formed.
361static std::pair<const SCEV *, const SCEV *>
362getNonAffineMonotonicBounds(const Loop *Lp, const SCEV *PtrExpr,
363 ScalarEvolution *SE) {
364 const auto *PtrAdd = dyn_cast<SCEVAddExpr>(PtrExpr);
365 if (!PtrAdd || !PtrAdd->hasNoUnsignedWrap())
366 return {nullptr, nullptr};
367
368 const SCEV *Base = *find_if(PtrAdd->operands(), [](const auto &Op) {
369 return Op->getType()->isPointerTy();
370 });
372 return {nullptr, nullptr};
373
374 const SCEV *Offset = SE->getMinusSCEV(PtrExpr, Base);
377 return {nullptr, nullptr};
378
379 const SCEV *OffStart = SE->SplitIntoInitAndPostInc(Lp, Offset).first;
380 const SCEV *OffEnd = SE->getSCEVAtScope(Offset, Lp->getParentLoop());
381 if (isa<SCEVCouldNotCompute>(OffStart) || isa<SCEVCouldNotCompute>(OffEnd) ||
382 !SE->isLoopInvariant(OffStart, Lp) || !SE->isLoopInvariant(OffEnd, Lp))
383 return {nullptr, nullptr};
384
385 return {SE->getAddExpr(Base, OffStart), SE->getAddExpr(Base, OffEnd)};
386}
387
388std::pair<const SCEV *, const SCEV *> llvm::getStartAndEndForAccess(
389 const Loop *Lp, const SCEV *PtrExpr, Type *AccessTy, const SCEV *BTC,
390 const SCEV *MaxBTC, ScalarEvolution *SE,
391 DenseMap<std::pair<const SCEV *, const SCEV *>,
392 std::pair<const SCEV *, const SCEV *>> *PointerBounds,
394 std::optional<ScalarEvolution::LoopGuards> &LoopGuards) {
395 auto &DL = Lp->getHeader()->getDataLayout();
396 Type *IdxTy = DL.getIndexType(PtrExpr->getType());
397 const SCEV *EltSizeSCEV = SE->getStoreSizeOfExpr(IdxTy, AccessTy);
398
399 // Delegate to the SCEV-based overload, passing through the cache.
400 return getStartAndEndForAccess(Lp, PtrExpr, EltSizeSCEV, BTC, MaxBTC, SE,
401 PointerBounds, DT, AC, LoopGuards);
402}
403
404std::pair<const SCEV *, const SCEV *> llvm::getStartAndEndForAccess(
405 const Loop *Lp, const SCEV *PtrExpr, const SCEV *EltSizeSCEV,
406 const SCEV *BTC, const SCEV *MaxBTC, ScalarEvolution *SE,
407 DenseMap<std::pair<const SCEV *, const SCEV *>,
408 std::pair<const SCEV *, const SCEV *>> *PointerBounds,
410 std::optional<ScalarEvolution::LoopGuards> &LoopGuards) {
411 std::pair<const SCEV *, const SCEV *> *PtrBoundsPair;
412 if (PointerBounds) {
413 auto [Iter, Ins] = PointerBounds->insert(
414 {{PtrExpr, EltSizeSCEV},
415 {SE->getCouldNotCompute(), SE->getCouldNotCompute()}});
416 if (!Ins)
417 return Iter->second;
418 PtrBoundsPair = &Iter->second;
419 }
420
421 const SCEV *ScStart;
422 const SCEV *ScEnd;
423
424 auto &DL = Lp->getHeader()->getDataLayout();
425 if (SE->isLoopInvariant(PtrExpr, Lp)) {
426 ScStart = ScEnd = PtrExpr;
427 } else if (auto *AR = dyn_cast<SCEVAddRecExpr>(PtrExpr)) {
428 ScStart = AR->getStart();
429 if (!isa<SCEVCouldNotCompute>(BTC))
430 // Evaluating AR at an exact BTC is safe: LAA separately checks that
431 // accesses cannot wrap in the loop. If evaluating AR at BTC wraps, then
432 // the loop either triggers UB when executing a memory access with a
433 // poison pointer or the wrapping/poisoned pointer is not used.
434 ScEnd = AR->evaluateAtIteration(BTC, *SE);
435 else {
436 // Evaluating AR at MaxBTC may wrap and create an expression that is less
437 // than the start of the AddRec due to wrapping (for example consider
438 // MaxBTC = -2). If that's the case, set ScEnd to -(EltSize + 1). ScEnd
439 // will get incremented by EltSize before returning, so this effectively
440 // sets ScEnd to the maximum unsigned value for the type. Note that LAA
441 // separately checks that accesses cannot not wrap, so unsigned max
442 // represents an upper bound.
443 if (evaluatePtrAddRecAtMaxBTCWillNotWrap(AR, MaxBTC, EltSizeSCEV, *SE, DL,
444 DT, AC, LoopGuards)) {
445 ScEnd = AR->evaluateAtIteration(MaxBTC, *SE);
446 } else {
447 ScEnd = SE->getAddExpr(
448 SE->getNegativeSCEV(EltSizeSCEV),
451 AR->getType())));
452 }
453 }
454 const SCEV *Step = AR->getStepRecurrence(*SE);
455
456 // For expressions with negative step, the upper bound is ScStart and the
457 // lower bound is ScEnd.
458 if (const auto *CStep = dyn_cast<SCEVConstant>(Step)) {
459 if (CStep->getValue()->isNegative())
460 std::swap(ScStart, ScEnd);
461 } else {
462 // Fallback case: the step is not constant, but we can still
463 // get the upper and lower bounds of the interval by using min/max
464 // expressions.
465 ScStart = SE->getUMinExpr(ScStart, ScEnd);
466 ScEnd = SE->getUMaxExpr(AR->getStart(), ScEnd);
467 }
468 } else {
469 // The pointer is loop-variant but not an affine AddRec. Try to form a
470 // tight bound for a monotonic offset (see getNonAffineMonotonicBounds).
471 std::tie(ScStart, ScEnd) = getNonAffineMonotonicBounds(Lp, PtrExpr, SE);
472 if (!ScStart)
473 return {SE->getCouldNotCompute(), SE->getCouldNotCompute()};
474 }
475
476 assert(SE->isLoopInvariant(ScStart, Lp) && "ScStart needs to be invariant");
477 assert(SE->isLoopInvariant(ScEnd, Lp) && "ScEnd needs to be invariant");
478
479 // Add the size of the pointed element to ScEnd.
480 ScEnd = SE->getAddExpr(ScEnd, EltSizeSCEV);
481
482 std::pair<const SCEV *, const SCEV *> Res = {ScStart, ScEnd};
483 if (PointerBounds)
484 *PtrBoundsPair = Res;
485 return Res;
486}
487
488/// Calculate Start and End points of memory access using
489/// getStartAndEndForAccess.
490void RuntimePointerChecking::insert(Loop *Lp, Value *Ptr, const SCEV *PtrExpr,
491 Type *AccessTy, bool WritePtr,
492 unsigned DepSetId, unsigned ASId,
494 bool NeedsFreeze) {
495 const SCEV *SymbolicMaxBTC = PSE.getSymbolicMaxBackedgeTakenCount();
496 const SCEV *BTC = PSE.getBackedgeTakenCount();
497 const auto &[ScStart, ScEnd] = getStartAndEndForAccess(
498 Lp, PtrExpr, AccessTy, BTC, SymbolicMaxBTC, PSE.getSE(),
499 &DC.getPointerBounds(), DC.getDT(), DC.getAC(), LoopGuards);
501 !isa<SCEVCouldNotCompute>(ScEnd) &&
502 "must be able to compute both start and end expressions");
503 Pointers.emplace_back(Ptr, ScStart, ScEnd, WritePtr, DepSetId, ASId, PtrExpr,
504 NeedsFreeze);
505}
506
507bool RuntimePointerChecking::tryToCreateDiffCheck(
508 const RuntimeCheckingPtrGroup &CGI, const RuntimeCheckingPtrGroup &CGJ) {
509 // If either group contains multiple different pointers, bail out.
510 // TODO: Support multiple pointers by using the minimum or maximum pointer,
511 // depending on src & sink.
512 if (CGI.Members.size() != 1 || CGJ.Members.size() != 1)
513 return false;
514
515 const PointerInfo *Src = &Pointers[CGI.Members[0]];
516 const PointerInfo *Sink = &Pointers[CGJ.Members[0]];
517
518 // If either pointer is read and written, multiple checks may be needed. Bail
519 // out.
520 if (!DC.getOrderForAccess(Src->PointerValue, !Src->IsWritePtr).empty() ||
521 !DC.getOrderForAccess(Sink->PointerValue, !Sink->IsWritePtr).empty())
522 return false;
523
524 ArrayRef<unsigned> AccSrc =
525 DC.getOrderForAccess(Src->PointerValue, Src->IsWritePtr);
526 ArrayRef<unsigned> AccSink =
527 DC.getOrderForAccess(Sink->PointerValue, Sink->IsWritePtr);
528 // If either pointer is accessed multiple times, there may not be a clear
529 // src/sink relation. Bail out for now.
530 if (AccSrc.size() != 1 || AccSink.size() != 1)
531 return false;
532
533 // If the sink is accessed before src, swap src/sink.
534 if (AccSink[0] < AccSrc[0])
535 std::swap(Src, Sink);
536
537 const SCEVConstant *Step;
538 const SCEV *SrcStart;
539 const SCEV *SinkStart;
540 const Loop *InnerLoop = DC.getInnermostLoop();
541 if (!match(Src->Expr,
543 m_SpecificLoop(InnerLoop))) ||
544 !match(Sink->Expr,
546 m_SpecificLoop(InnerLoop))))
547 return false;
548
550 DC.getInstructionsForAccess(Src->PointerValue, Src->IsWritePtr);
552 DC.getInstructionsForAccess(Sink->PointerValue, Sink->IsWritePtr);
553 Type *SrcTy = getLoadStoreType(SrcInsts[0]);
554 Type *DstTy = getLoadStoreType(SinkInsts[0]);
556 return false;
557
558 const DataLayout &DL = InnerLoop->getHeader()->getDataLayout();
559 unsigned AllocSize =
560 std::max(DL.getTypeAllocSize(SrcTy), DL.getTypeAllocSize(DstTy));
561
562 // Only matching constant steps matching the AllocSize are supported at the
563 // moment. This simplifies the difference computation. Can be extended in the
564 // future.
565 if (Step->getAPInt().abs() != AllocSize)
566 return false;
567
568 // When counting down, the dependence distance needs to be swapped.
569 if (Step->getValue()->isNegative())
570 std::swap(SinkStart, SrcStart);
571
572 const SCEV *SinkStartInt = SE->getPtrToAddrExpr(SinkStart);
573 const SCEV *SrcStartInt = SE->getPtrToAddrExpr(SrcStart);
574 if (isa<SCEVCouldNotCompute>(SinkStartInt) ||
575 isa<SCEVCouldNotCompute>(SrcStartInt))
576 return false;
577
578 // If the start values for both Src and Sink also vary according to an outer
579 // loop, then it's probably better to avoid creating diff checks because
580 // they may not be hoisted. We should instead let llvm::addRuntimeChecks
581 // do the expanded full range overlap checks, which can be hoisted.
582 if (HoistRuntimeChecks && InnerLoop->getParentLoop() &&
583 isa<SCEVAddRecExpr>(SinkStartInt) && isa<SCEVAddRecExpr>(SrcStartInt)) {
584 auto *SrcStartAR = cast<SCEVAddRecExpr>(SrcStartInt);
585 auto *SinkStartAR = cast<SCEVAddRecExpr>(SinkStartInt);
586 const Loop *StartARLoop = SrcStartAR->getLoop();
587 if (StartARLoop == SinkStartAR->getLoop() &&
588 StartARLoop == InnerLoop->getParentLoop() &&
589 // If the diff check would already be loop invariant (due to the
590 // recurrences being the same), then we prefer to keep the diff checks
591 // because they are cheaper.
592 SrcStartAR->getStepRecurrence(*SE) !=
593 SinkStartAR->getStepRecurrence(*SE)) {
594 LLVM_DEBUG(dbgs() << "LAA: Not creating diff runtime check, since these "
595 "cannot be hoisted out of the outer loop\n");
596 return false;
597 }
598 }
599
600 LLVM_DEBUG(dbgs() << "LAA: Creating diff runtime check for:\n"
601 << "SrcStart: " << *SrcStartInt << '\n'
602 << "SinkStartInt: " << *SinkStartInt << '\n');
603 DiffChecks.emplace_back(SrcStartInt, SinkStartInt, AllocSize,
604 Src->NeedsFreeze || Sink->NeedsFreeze);
605 return true;
606}
607
609 SmallVector<RuntimePointerCheck, 4> Checks;
610
611 for (unsigned I = 0; I < CheckingGroups.size(); ++I) {
612 for (unsigned J = I + 1; J < CheckingGroups.size(); ++J) {
615
616 if (needsChecking(CGI, CGJ)) {
617 CanUseDiffCheck = CanUseDiffCheck && tryToCreateDiffCheck(CGI, CGJ);
618 Checks.emplace_back(&CGI, &CGJ);
619 }
620 }
621 }
622 return Checks;
623}
624
627 assert(Checks.empty() && "Checks is not empty");
628 groupChecks(DepCands);
629 Checks = generateChecks();
630}
631
633 const RuntimeCheckingPtrGroup &M, const RuntimeCheckingPtrGroup &N) const {
634 for (const auto &I : M.Members)
635 for (const auto &J : N.Members)
636 if (needsChecking(I, J))
637 return true;
638 return false;
639}
640
641/// Compare \p I and \p J and return the minimum.
642/// Return nullptr in case we couldn't find an answer.
643static const SCEV *getMinFromExprs(const SCEV *I, const SCEV *J,
644 ScalarEvolution *SE) {
645 std::optional<APInt> Diff = SE->computeConstantDifference(J, I);
646 if (!Diff)
647 return nullptr;
648 return Diff->isNegative() ? J : I;
649}
650
652 unsigned Index, const RuntimePointerChecking &RtCheck) {
653 return addPointer(
654 Index, RtCheck.Pointers[Index].Start, RtCheck.Pointers[Index].End,
655 RtCheck.Pointers[Index].PointerValue->getType()->getPointerAddressSpace(),
656 RtCheck.Pointers[Index].NeedsFreeze, *RtCheck.SE);
657}
658
659bool RuntimeCheckingPtrGroup::addPointer(unsigned Index, const SCEV *Start,
660 const SCEV *End, unsigned AS,
661 bool NeedsFreeze,
662 ScalarEvolution &SE) {
663 assert(AddressSpace == AS &&
664 "all pointers in a checking group must be in the same address space");
665
666 // Compare the starts and ends with the known minimum and maximum
667 // of this set. We need to know how we compare against the min/max
668 // of the set in order to be able to emit memchecks.
669 const SCEV *Min0 = getMinFromExprs(Start, Low, &SE);
670 if (!Min0)
671 return false;
672
673 const SCEV *Min1 = getMinFromExprs(End, High, &SE);
674 if (!Min1)
675 return false;
676
677 // Update the low bound expression if we've found a new min value.
678 if (Min0 == Start)
679 Low = Start;
680
681 // Update the high bound expression if we've found a new max value.
682 if (Min1 != End)
683 High = End;
684
685 Members.push_back(Index);
686 this->NeedsFreeze |= NeedsFreeze;
687 return true;
688}
689
690void RuntimePointerChecking::groupChecks(
692 // We build the groups from dependency candidates equivalence classes
693 // because:
694 // - We know that pointers in the same equivalence class share
695 // the same underlying object and therefore there is a chance
696 // that we can compare pointers
697 // - We wouldn't be able to merge two pointers for which we need
698 // to emit a memcheck. The classes in DepCands are already
699 // conveniently built such that no two pointers in the same
700 // class need checking against each other.
701
702 // We use the following (greedy) algorithm to construct the groups
703 // For every pointer in the equivalence class:
704 // For each existing group:
705 // - if the difference between this pointer and the min/max bounds
706 // of the group is a constant, then make the pointer part of the
707 // group and update the min/max bounds of that group as required.
708
709 CheckingGroups.clear();
710
711 // If we need to check two pointers to the same underlying object
712 // with a non-constant difference, we shouldn't perform any pointer
713 // grouping with those pointers. This is because we can easily get
714 // into cases where the resulting check would return false, even when
715 // the accesses are safe.
716 //
717 // The following example shows this:
718 // for (i = 0; i < 1000; ++i)
719 // a[5000 + i * m] = a[i] + a[i + 9000]
720 //
721 // Here grouping gives a check of (5000, 5000 + 1000 * m) against
722 // (0, 10000) which is always false. However, if m is 1, there is no
723 // dependence. Not grouping the checks for a[i] and a[i + 9000] allows
724 // us to perform an accurate check in this case.
725 //
726 // In the above case, we have a non-constant distance and an Unknown
727 // dependence between accesses to the same underlying object, and could retry
728 // with runtime checks without dependency information being available. In this
729 // case we will use the fallback path and create separate checking groups for
730 // accesses not present in DepCands.
731
732 unsigned TotalComparisons = 0;
733
735 for (unsigned Index = 0; Index < Pointers.size(); ++Index)
736 PositionMap[Pointers[Index].PointerValue].push_back(Index);
737
738 // We need to keep track of what pointers we've already seen so we
739 // don't process them twice.
741
742 // Go through all equivalence classes, get the "pointer check groups"
743 // and add them to the overall solution. We use the order in which accesses
744 // appear in 'Pointers' to enforce determinism.
745 for (unsigned I = 0; I < Pointers.size(); ++I) {
746 // We've seen this pointer before, and therefore already processed
747 // its equivalence class.
748 if (Seen.contains(I))
749 continue;
750
752 Pointers[I].IsWritePtr);
753
754 // If there is no entry in the dependency partition, there are no potential
755 // accesses to merge; simply add a new pointer checking group.
756 if (!DepCands.contains(Access)) {
757 CheckingGroups.push_back(RuntimeCheckingPtrGroup(I, *this));
758 continue;
759 }
760
762
763 // Because DepCands is constructed by visiting accesses in the order in
764 // which they appear in alias sets (which is deterministic) and the
765 // iteration order within an equivalence class member is only dependent on
766 // the order in which unions and insertions are performed on the
767 // equivalence class, the iteration order is deterministic.
768 for (auto M : DepCands.members(Access)) {
769 auto PointerI = PositionMap.find(M.getPointer());
770 // If we can't find the pointer in PositionMap that means we can't
771 // generate a memcheck for it.
772 if (PointerI == PositionMap.end())
773 continue;
774 for (unsigned Pointer : PointerI->second) {
775 bool Merged = false;
776 // Mark this pointer as seen.
777 Seen.insert(Pointer);
778
779 // Go through all the existing sets and see if we can find one
780 // which can include this pointer.
781 for (RuntimeCheckingPtrGroup &Group : Groups) {
782 // Don't perform more than a certain amount of comparisons.
783 // This should limit the cost of grouping the pointers to something
784 // reasonable. If we do end up hitting this threshold, the algorithm
785 // will create separate groups for all remaining pointers.
786 if (TotalComparisons > MemoryCheckMergeThreshold)
787 break;
788
789 TotalComparisons++;
790
791 if (Group.addPointer(Pointer, *this)) {
792 Merged = true;
793 break;
794 }
795 }
796
797 if (!Merged)
798 // We couldn't add this pointer to any existing set or the threshold
799 // for the number of comparisons has been reached. Create a new group
800 // to hold the current pointer.
801 Groups.emplace_back(Pointer, *this);
802 }
803 }
804
805 // We've computed the grouped checks for this partition.
806 // Save the results and continue with the next one.
808 }
809}
810
812 const SmallVectorImpl<int> &PtrToPartition, unsigned PtrIdx1,
813 unsigned PtrIdx2) {
814 return (PtrToPartition[PtrIdx1] != -1 &&
815 PtrToPartition[PtrIdx1] == PtrToPartition[PtrIdx2]);
816}
817
818bool RuntimePointerChecking::needsChecking(unsigned I, unsigned J) const {
819 const PointerInfo &PointerI = Pointers[I];
820 const PointerInfo &PointerJ = Pointers[J];
821
822 // No need to check if two readonly pointers intersect.
823 if (!PointerI.IsWritePtr && !PointerJ.IsWritePtr)
824 return false;
825
826 // Only need to check pointers between two different dependency sets.
827 if (PointerI.DependencySetId == PointerJ.DependencySetId)
828 return false;
829
830 // Only need to check pointers in the same alias set.
831 return PointerI.AliasSetId == PointerJ.AliasSetId;
832}
833
834/// Assign each RuntimeCheckingPtrGroup pointer an index for stable UTC output.
838 for (const auto &[Idx, CG] : enumerate(CheckingGroups))
839 PtrIndices[&CG] = Idx;
840 return PtrIndices;
841}
842
845 unsigned Depth) const {
846 unsigned N = 0;
847 auto PtrIndices = getPtrToIdxMap(CheckingGroups);
848 for (const auto &[Check1, Check2] : Checks) {
849 const auto &First = Check1->Members, &Second = Check2->Members;
850 OS.indent(Depth) << "Check " << N++ << ":\n";
851 OS.indent(Depth + 2) << "Comparing group GRP" << PtrIndices.at(Check1)
852 << ":\n";
853 for (unsigned K : First)
854 OS.indent(Depth + 2) << *Pointers[K].PointerValue << "\n";
855 OS.indent(Depth + 2) << "Against group GRP" << PtrIndices.at(Check2)
856 << ":\n";
857 for (unsigned K : Second)
858 OS.indent(Depth + 2) << *Pointers[K].PointerValue << "\n";
859 }
860}
861
863
864 OS.indent(Depth) << "Run-time memory checks:\n";
865 printChecks(OS, Checks, Depth);
866
867 OS.indent(Depth) << "Grouped accesses:\n";
868 auto PtrIndices = getPtrToIdxMap(CheckingGroups);
869 for (const auto &CG : CheckingGroups) {
870 OS.indent(Depth + 2) << "Group GRP" << PtrIndices.at(&CG) << ":\n";
871 OS.indent(Depth + 4) << "(Low: " << *CG.Low << " High: " << *CG.High
872 << ")\n";
873 for (unsigned Member : CG.Members) {
874 OS.indent(Depth + 6) << "Member: " << *Pointers[Member].Expr << "\n";
875 }
876 }
877}
878
879namespace {
880
881/// Analyses memory accesses in a loop.
882///
883/// Checks whether run time pointer checks are needed and builds sets for data
884/// dependence checking.
885class AccessAnalysis {
886public:
887 using MemAccessInfo =
888 PointerIntPair<Value * /* AccessPtr */, 1, bool /* IsWrite */>;
889
890 AccessAnalysis(const Loop *TheLoop, AAResults *AA, const LoopInfo *LI,
893 SmallPtrSetImpl<MDNode *> &LoopAliasScopes)
894 : TheLoop(TheLoop), BAA(*AA), AST(BAA), LI(LI), DT(DT), DepCands(DA),
895 PSE(PSE), LoopAliasScopes(LoopAliasScopes) {
896 // We're analyzing dependences across loop iterations.
897 BAA.enableCrossIterationMode();
898 }
899
900 /// Register a load and whether it is only read from.
901 void addLoad(const MemoryLocation &Loc, Type *AccessTy, bool IsReadOnly) {
902 Value *Ptr = const_cast<Value *>(Loc.Ptr);
903 AST.add(adjustLoc(Loc));
904 Accesses[MemAccessInfo(Ptr, false)].insert(AccessTy);
905 if (IsReadOnly)
906 ReadOnlyPtr.insert(Ptr);
907 }
908
909 /// Register a store.
910 void addStore(const MemoryLocation &Loc, Type *AccessTy) {
911 Value *Ptr = const_cast<Value *>(Loc.Ptr);
912 AST.add(adjustLoc(Loc));
913 Accesses[MemAccessInfo(Ptr, true)].insert(AccessTy);
914 }
915
916 /// Check if we can emit a run-time no-alias check for \p Access.
917 ///
918 /// Returns true if we can emit a run-time no alias check for \p Access.
919 /// If we can check this access, this also adds it to a dependence set and
920 /// adds a run-time to check for it to \p RtCheck. If \p Assume is true,
921 /// we will attempt to use additional run-time checks in order to get
922 /// the bounds of the pointer.
923 bool createCheckForAccess(RuntimePointerChecking &RtCheck,
924 MemAccessInfo Access, Type *AccessTy,
925 const SymbolicStrideMap &Strides,
926 DenseMap<Value *, unsigned> &DepSetId,
927 Loop *TheLoop, unsigned &RunningDepId,
928 unsigned ASId, bool Assume);
929
930 /// Check whether we can check the pointers at runtime for
931 /// non-intersection.
932 ///
933 /// Returns true if we need no check or if we do and we can generate them
934 /// (i.e. the pointers have computable bounds). A return value of false means
935 /// we couldn't analyze and generate runtime checks for all pointers in the
936 /// loop, but if \p AllowPartial is set then we will have checks for those
937 /// pointers we could analyze. \p DepChecker is used to remove unknown
938 /// dependences from DepCands.
939 bool canCheckPtrAtRT(RuntimePointerChecking &RtCheck, Loop *TheLoop,
940 const SymbolicStrideMap &Strides,
941 Value *&UncomputablePtr, bool AllowPartial,
942 const MemoryDepChecker &DepChecker);
943
944 /// Goes over all memory accesses, checks whether a RT check is needed
945 /// and builds sets of dependent accesses.
946 void buildDependenceSets();
947
948 /// Initial processing of memory accesses determined that we need to
949 /// perform dependency checking.
950 ///
951 /// Note that this can later be cleared if we retry memcheck analysis without
952 /// dependency checking (i.e. ShouldRetryWithRuntimeChecks).
953 bool isDependencyCheckNeeded() const { return !CheckDeps.empty(); }
954
955 /// We decided that no dependence analysis would be used. Reset the state.
956 void resetDepChecks(MemoryDepChecker &DepChecker) {
957 CheckDeps.clear();
958 DepChecker.clearDependences();
959 }
960
961 ArrayRef<MemAccessInfo> getDependenciesToCheck() const { return CheckDeps; }
962
963private:
964 using PtrAccessMap = MapVector<MemAccessInfo, SmallSetVector<Type *, 1>>;
965
966 /// Adjust the MemoryLocation so that it represents accesses to this
967 /// location across all iterations, rather than a single one.
968 MemoryLocation adjustLoc(MemoryLocation Loc) const {
969 // The accessed location varies within the loop, but remains within the
970 // underlying object.
972 Loc.AATags.Scope = adjustAliasScopeList(Loc.AATags.Scope);
973 Loc.AATags.NoAlias = adjustAliasScopeList(Loc.AATags.NoAlias);
974 return Loc;
975 }
976
977 /// Drop alias scopes that are only valid within a single loop iteration.
978 MDNode *adjustAliasScopeList(MDNode *ScopeList) const {
979 if (!ScopeList)
980 return nullptr;
981
982 // For the sake of simplicity, drop the whole scope list if any scope is
983 // iteration-local.
984 if (any_of(ScopeList->operands(), [&](Metadata *Scope) {
985 return LoopAliasScopes.contains(cast<MDNode>(Scope));
986 }))
987 return nullptr;
988
989 return ScopeList;
990 }
991
992 /// Map of all accesses. Values are the types used to access memory pointed to
993 /// by the pointer.
994 PtrAccessMap Accesses;
995
996 /// The loop being checked.
997 const Loop *TheLoop;
998
999 /// List of accesses that need a further dependence check.
1001
1002 /// Set of pointers that are read only.
1003 SmallPtrSet<Value*, 16> ReadOnlyPtr;
1004
1005 /// Batched alias analysis results.
1006 BatchAAResults BAA;
1007
1008 /// An alias set tracker to partition the access set by underlying object and
1009 //intrinsic property (such as TBAA metadata).
1010 AliasSetTracker AST;
1011
1012 /// The LoopInfo of the loop being checked.
1013 const LoopInfo *LI;
1014
1015 /// The dominator tree of the function.
1016 DominatorTree &DT;
1017
1018 /// Sets of potentially dependent accesses - members of one set share an
1019 /// underlying pointer. The set "CheckDeps" identfies which sets really need a
1020 /// dependence check.
1022
1023 /// Initial processing of memory accesses determined that we may need
1024 /// to add memchecks. Perform the analysis to determine the necessary checks.
1025 ///
1026 /// Note that, this is different from isDependencyCheckNeeded. When we retry
1027 /// memcheck analysis without dependency checking
1028 /// (i.e. ShouldRetryWithRuntimeChecks), isDependencyCheckNeeded is
1029 /// cleared while this remains set if we have potentially dependent accesses.
1030 bool IsRTCheckAnalysisNeeded = false;
1031
1032 /// The SCEV predicate containing all the SCEV-related assumptions.
1033 PredicatedScalarEvolution &PSE;
1034
1035 DenseMap<Value *, SmallVector<const Value *, 16>> UnderlyingObjects;
1036
1037 /// Alias scopes that are declared inside the loop, and as such not valid
1038 /// across iterations.
1039 SmallPtrSetImpl<MDNode *> &LoopAliasScopes;
1040};
1041
1042} // end anonymous namespace
1043
1044std::optional<int64_t>
1046 Type *AccessTy, Value *Ptr,
1048 if (isa<ScalableVectorType>(AccessTy)) {
1049 LLVM_DEBUG(dbgs() << "LAA: Bad stride - Scalable object: " << *AccessTy
1050 << "\n");
1051 return std::nullopt;
1052 }
1053
1054 // The access function must stride over the innermost loop.
1055 if (Lp != AR->getLoop()) {
1056 LLVM_DEBUG({
1057 dbgs() << "LAA: Bad stride - Not striding over innermost loop ";
1058 if (Ptr)
1059 dbgs() << *Ptr << " ";
1060
1061 dbgs() << "SCEV: " << *AR << "\n";
1062 });
1063 return std::nullopt;
1064 }
1065
1066 // Check the step is constant.
1067 const SCEV *Step = AR->getStepRecurrence(*PSE.getSE());
1068
1069 // Calculate the pointer stride and check if it is constant.
1070 const APInt *APStepVal;
1071 if (!match(Step, m_scev_APInt(APStepVal))) {
1072 LLVM_DEBUG({
1073 dbgs() << "LAA: Bad stride - Not a constant strided ";
1074 if (Ptr)
1075 dbgs() << *Ptr << " ";
1076 dbgs() << "SCEV: " << *AR << "\n";
1077 });
1078 return std::nullopt;
1079 }
1080
1081 const auto &DL = Lp->getHeader()->getDataLayout();
1082 TypeSize AllocSize = DL.getTypeAllocSize(AccessTy);
1083 int64_t Size = AllocSize.getFixedValue();
1084
1085 // Huge step value - give up.
1086 std::optional<int64_t> StepVal = APStepVal->trySExtValue();
1087 if (!StepVal)
1088 return std::nullopt;
1089
1090 // Strided access.
1091 return *StepVal % Size ? std::nullopt : std::make_optional(*StepVal / Size);
1092}
1093
1094/// Check whether \p AR is a non-wrapping AddRec. If \p Ptr is not nullptr, use
1095/// information from the IR pointer value to determine no-wrap. If \p Predicates
1096/// is not nullptr add no-wrap assumptions if needed.
1097static bool
1099 Type *AccessTy, const Loop *L, const DominatorTree &DT,
1100 std::optional<int64_t> Stride = std::nullopt,
1101 SmallVectorImpl<const SCEVPredicate *> *Predicates = nullptr) {
1102 // FIXME: This should probably only return true for NUW.
1103 if (any(AR->getNoWrapFlags(SCEV::NoWrapMask)))
1104 return true;
1105
1107 return true;
1108
1109 // An nusw getelementptr that is an AddRec cannot wrap. If it would wrap,
1110 // the distance between the previously accessed location and the wrapped
1111 // location will be larger than half the pointer index type space. In that
1112 // case, the GEP would be poison and any memory access dependent on it would
1113 // be immediate UB when executed.
1115 GEP && GEP->hasNoUnsignedSignedWrap()) {
1116 // For the above reasoning to apply, the pointer must be dereferenced in
1117 // every iteration.
1118 if (L->getHeader() == L->getLoopLatch() ||
1119 any_of(GEP->users(), [L, &DT, GEP](User *U) {
1120 if (getLoadStorePointerOperand(U) != GEP)
1121 return false;
1122 BasicBlock *UserBB = cast<Instruction>(U)->getParent();
1123 if (!L->contains(UserBB))
1124 return false;
1125 return !LoopAccessInfo::blockNeedsPredication(UserBB, L, &DT);
1126 }))
1127 return true;
1128 }
1129
1130 if (!Stride)
1131 Stride = getStrideFromAddRec(AR, L, AccessTy, Ptr, PSE);
1132 if (Stride) {
1133 // If the null pointer is undefined, then a access sequence which would
1134 // otherwise access it can be assumed not to unsigned wrap. Note that this
1135 // assumes the object in memory is aligned to the natural alignment.
1136 unsigned AddrSpace = AR->getType()->getPointerAddressSpace();
1137 if (!NullPointerIsDefined(L->getHeader()->getParent(), AddrSpace) &&
1138 (Stride == 1 || Stride == -1))
1139 return true;
1140 }
1141
1142 if (Ptr && Predicates) {
1143 ScalarEvolution &SE = *PSE.getSE();
1147 Predicates->push_back(SE.getWrapPredicate(AR, Flags));
1148 LLVM_DEBUG(dbgs() << "LAA: Pointer may wrap:\n"
1149 << "LAA: Pointer: " << *Ptr << "\n"
1150 << "LAA: SCEV: " << *AR << "\n"
1151 << "LAA: Added an overflow assumption\n");
1152 return true;
1153 }
1154
1155 return false;
1156}
1157
1158static void visitPointers(Value *StartPtr, const Loop &InnermostLoop,
1159 function_ref<void(Value *)> AddPointer) {
1161 SmallVector<Value *> WorkList;
1162 WorkList.push_back(StartPtr);
1163
1164 while (!WorkList.empty()) {
1165 Value *Ptr = WorkList.pop_back_val();
1166 if (!Visited.insert(Ptr).second)
1167 continue;
1168 auto *PN = dyn_cast<PHINode>(Ptr);
1169 // SCEV does not look through non-header PHIs inside the loop. Such phis
1170 // can be analyzed by adding separate accesses for each incoming pointer
1171 // value.
1172 if (PN && InnermostLoop.contains(PN->getParent()) &&
1173 PN->getParent() != InnermostLoop.getHeader()) {
1174 llvm::append_range(WorkList, PN->incoming_values());
1175 } else
1176 AddPointer(Ptr);
1177 }
1178}
1179
1180// Walk back through the IR for a pointer, looking for a select like the
1181// following:
1182//
1183// %offset = select i1 %cmp, i64 %a, i64 %b
1184// %addr = getelementptr double, double* %base, i64 %offset
1185// %ld = load double, double* %addr, align 8
1186//
1187// We won't be able to form a single SCEVAddRecExpr from this since the
1188// address for each loop iteration depends on %cmp. We could potentially
1189// produce multiple valid SCEVAddRecExprs, though, and check all of them for
1190// memory safety/aliasing if needed.
1191//
1192// If we encounter some IR we don't yet handle, or something obviously fine
1193// like a constant, then we just add the SCEV for that term to the list passed
1194// in by the caller. If we have a node that may potentially yield a valid
1195// SCEVAddRecExpr then we decompose it into parts and build the SCEV terms
1196// ourselves before adding to the list.
1198 ScalarEvolution *SE, const Loop *L, Value *Ptr,
1200 unsigned Depth) {
1201 // If our Value is a SCEVAddRecExpr, loop invariant, not an instruction, or
1202 // we've exceeded our limit on recursion, just return whatever we have
1203 // regardless of whether it can be used for a forked pointer or not, along
1204 // with an indication of whether it might be a poison or undef value.
1205 const SCEV *Scev = SE->getSCEV(Ptr);
1206 if (isa<SCEVAddRecExpr>(Scev) || L->isLoopInvariant(Ptr) ||
1207 !isa<Instruction>(Ptr) || Depth == 0) {
1208 ScevList.emplace_back(Scev, !isGuaranteedNotToBeUndefOrPoison(Ptr));
1209 return;
1210 }
1211
1212 Depth--;
1213
1214 auto UndefPoisonCheck = [](PointerIntPair<const SCEV *, 1, bool> S) {
1215 return get<1>(S);
1216 };
1217
1218 auto GetBinOpExpr = [&SE](unsigned Opcode, const SCEV *L, const SCEV *R) {
1219 switch (Opcode) {
1220 case Instruction::Add:
1221 return SE->getAddExpr(L, R);
1222 case Instruction::Sub:
1223 return SE->getMinusSCEV(L, R);
1224 default:
1225 llvm_unreachable("Unexpected binary operator when walking ForkedPtrs");
1226 }
1227 };
1228
1230 unsigned Opcode = I->getOpcode();
1231 switch (Opcode) {
1232 case Instruction::GetElementPtr: {
1233 auto *GEP = cast<GetElementPtrInst>(I);
1234 Type *SourceTy = GEP->getSourceElementType();
1235 // We only handle base + single offset GEPs here for now.
1236 // Not dealing with preexisting gathers yet, so no vectors.
1237 if (I->getNumOperands() != 2 || SourceTy->isVectorTy()) {
1238 ScevList.emplace_back(Scev, !isGuaranteedNotToBeUndefOrPoison(GEP));
1239 break;
1240 }
1243 findForkedSCEVs(SE, L, I->getOperand(0), BaseScevs, Depth);
1244 findForkedSCEVs(SE, L, I->getOperand(1), OffsetScevs, Depth);
1245
1246 // See if we need to freeze our fork...
1247 bool NeedsFreeze = any_of(BaseScevs, UndefPoisonCheck) ||
1248 any_of(OffsetScevs, UndefPoisonCheck);
1249
1250 // Check that we only have a single fork, on either the base or the offset.
1251 // Copy the SCEV across for the one without a fork in order to generate
1252 // the full SCEV for both sides of the GEP.
1253 if (OffsetScevs.size() == 2 && BaseScevs.size() == 1)
1254 BaseScevs.push_back(BaseScevs[0]);
1255 else if (BaseScevs.size() == 2 && OffsetScevs.size() == 1)
1256 OffsetScevs.push_back(OffsetScevs[0]);
1257 else {
1258 ScevList.emplace_back(Scev, NeedsFreeze);
1259 break;
1260 }
1261
1262 Type *IntPtrTy = SE->getEffectiveSCEVType(GEP->getPointerOperandType());
1263
1264 // Find the size of the type being pointed to. We only have a single
1265 // index term (guarded above) so we don't need to index into arrays or
1266 // structures, just get the size of the scalar value.
1267 const SCEV *Size = SE->getSizeOfExpr(IntPtrTy, SourceTy);
1268
1269 for (auto [B, O] : zip(BaseScevs, OffsetScevs)) {
1270 const SCEV *Base = get<0>(B);
1271 const SCEV *Offset = get<0>(O);
1272
1273 // Scale up the offsets by the size of the type, then add to the bases.
1274 const SCEV *Scaled =
1276 ScevList.emplace_back(SE->getAddExpr(Base, Scaled), NeedsFreeze);
1277 }
1278 break;
1279 }
1280 case Instruction::Select: {
1282 // A select means we've found a forked pointer, but we currently only
1283 // support a single select per pointer so if there's another behind this
1284 // then we just bail out and return the generic SCEV.
1285 findForkedSCEVs(SE, L, I->getOperand(1), ChildScevs, Depth);
1286 findForkedSCEVs(SE, L, I->getOperand(2), ChildScevs, Depth);
1287 if (ChildScevs.size() == 2)
1288 append_range(ScevList, ChildScevs);
1289 else
1290 ScevList.emplace_back(Scev, !isGuaranteedNotToBeUndefOrPoison(Ptr));
1291 break;
1292 }
1293 case Instruction::PHI: {
1295 // A phi means we've found a forked pointer, but we currently only
1296 // support a single phi per pointer so if there's another behind this
1297 // then we just bail out and return the generic SCEV.
1298 if (I->getNumOperands() == 2) {
1299 findForkedSCEVs(SE, L, I->getOperand(0), ChildScevs, Depth);
1300 findForkedSCEVs(SE, L, I->getOperand(1), ChildScevs, Depth);
1301 }
1302 if (ChildScevs.size() == 2)
1303 append_range(ScevList, ChildScevs);
1304 else
1305 ScevList.emplace_back(Scev, !isGuaranteedNotToBeUndefOrPoison(Ptr));
1306 break;
1307 }
1308 case Instruction::Add:
1309 case Instruction::Sub: {
1312 findForkedSCEVs(SE, L, I->getOperand(0), LScevs, Depth);
1313 findForkedSCEVs(SE, L, I->getOperand(1), RScevs, Depth);
1314
1315 // See if we need to freeze our fork...
1316 bool NeedsFreeze =
1317 any_of(LScevs, UndefPoisonCheck) || any_of(RScevs, UndefPoisonCheck);
1318
1319 // Check that we only have a single fork, on either the left or right side.
1320 // Copy the SCEV across for the one without a fork in order to generate
1321 // the full SCEV for both sides of the BinOp.
1322 if (LScevs.size() == 2 && RScevs.size() == 1)
1323 RScevs.push_back(RScevs[0]);
1324 else if (RScevs.size() == 2 && LScevs.size() == 1)
1325 LScevs.push_back(LScevs[0]);
1326 else {
1327 ScevList.emplace_back(Scev, NeedsFreeze);
1328 break;
1329 }
1330
1331 for (auto [L, R] : zip(LScevs, RScevs))
1332 ScevList.emplace_back(GetBinOpExpr(Opcode, get<0>(L), get<0>(R)),
1333 NeedsFreeze);
1334 break;
1335 }
1336 default:
1337 // Just return the current SCEV if we haven't handled the instruction yet.
1338 LLVM_DEBUG(dbgs() << "ForkedPtr unhandled instruction: " << *I << "\n");
1339 ScevList.emplace_back(Scev, !isGuaranteedNotToBeUndefOrPoison(Ptr));
1340 break;
1341 }
1342}
1343
1344bool AccessAnalysis::createCheckForAccess(RuntimePointerChecking &RtCheck,
1345 MemAccessInfo Access, Type *AccessTy,
1346 const SymbolicStrideMap &StridesMap,
1348 Loop *TheLoop, unsigned &RunningDepId,
1349 unsigned ASId, bool Assume) {
1350 Value *Ptr = Access.getPointer();
1351 ScalarEvolution *SE = PSE.getSE();
1352 assert(SE->isSCEVable(Ptr->getType()) && "Value is not SCEVable!");
1353
1355 findForkedSCEVs(SE, TheLoop, Ptr, RTCheckPtrs, MaxForkedSCEVDepth);
1356 assert(!RTCheckPtrs.empty() &&
1357 "Must have some runtime-check pointer candidates");
1358
1359 // RTCheckPtrs must have size 2 if there are forked pointers. Otherwise, there
1360 // are no forked pointers; replaceSymbolicStridesSCEV in this case.
1361 auto IsLoopInvariantOrAR =
1362 [&SE, &TheLoop](const PointerIntPair<const SCEV *, 1, bool> &P) {
1363 return SE->isLoopInvariant(P.getPointer(), TheLoop) ||
1364 isa<SCEVAddRecExpr>(P.getPointer());
1365 };
1366 if (RTCheckPtrs.size() == 2 && all_of(RTCheckPtrs, IsLoopInvariantOrAR)) {
1367 LLVM_DEBUG(dbgs() << "LAA: Found forked pointer: " << *Ptr << "\n";
1368 for (const auto &[Idx, Q] : enumerate(RTCheckPtrs)) dbgs()
1369 << "\t(" << Idx << ") " << *Q.getPointer() << "\n");
1370 } else {
1371 RTCheckPtrs = {{replaceSymbolicStrideSCEV(PSE, StridesMap, Ptr), false}};
1372 }
1373
1374 /// Check whether all pointers can participate in a runtime bounds check. They
1375 /// must either be invariant or non-wrapping affine AddRecs.
1377 for (auto &P : RTCheckPtrs) {
1378 // The bounds for loop-invariant pointer is trivial.
1379 if (SE->isLoopInvariant(P.getPointer(), TheLoop))
1380 continue;
1381
1382 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(P.getPointer());
1383 if (!AR && Assume)
1384 AR = PSE.getAsAddRec(Ptr, &Predicates);
1385 if (!AR || !AR->isAffine()) {
1386 // Check if bounds for non-affine monotonic expressions can be formed.
1387 if (!Assume ||
1388 !getNonAffineMonotonicBounds(TheLoop, P.getPointer(), SE).first)
1389 return false;
1390 continue;
1391 }
1392
1393 // If there's only one option for Ptr, commit the predicates collected by
1394 // getAsAddRec and look Ptr up again afterwards: the lookup below reads the
1395 // assumptions back from PSE, so they need to be committed first.
1396 if (RTCheckPtrs.size() == 1) {
1397 PSE.addPredicates(Predicates);
1398 Predicates.clear();
1399 if (auto *StrideAR = dyn_cast<SCEVAddRecExpr>(
1400 replaceSymbolicStrideSCEV(PSE, StridesMap, Ptr)))
1401 AR = StrideAR;
1402 P.setPointer(AR);
1403 }
1404
1405 if (!isNoWrap(PSE, AR, RTCheckPtrs.size() == 1 ? Ptr : nullptr, AccessTy,
1406 TheLoop, DT, /*Stride=*/std::nullopt,
1407 Assume ? &Predicates : nullptr))
1408 return false;
1409 }
1410 PSE.addPredicates(Predicates);
1411
1412 for (const auto &[PtrExpr, NeedsFreeze] : RTCheckPtrs) {
1413 // The id of the dependence set.
1414 unsigned DepId;
1415
1416 if (DepCands.contains(Access)) {
1417 Value *Leader = DepCands.getLeaderValue(Access).getPointer();
1418 unsigned &LeaderId = DepSetId[Leader];
1419 if (!LeaderId)
1420 LeaderId = RunningDepId++;
1421 DepId = LeaderId;
1422 } else
1423 // Each access has its own dependence set.
1424 DepId = RunningDepId++;
1425
1426 bool IsWrite = Access.getInt();
1427 RtCheck.insert(TheLoop, Ptr, PtrExpr, AccessTy, IsWrite, DepId, ASId, PSE,
1428 NeedsFreeze);
1429 LLVM_DEBUG(dbgs() << "LAA: Found a runtime check ptr:" << *Ptr << '\n');
1430 }
1431
1432 return true;
1433}
1434
1435bool AccessAnalysis::canCheckPtrAtRT(RuntimePointerChecking &RtCheck,
1436 Loop *TheLoop,
1437 const SymbolicStrideMap &StridesMap,
1438 Value *&UncomputablePtr, bool AllowPartial,
1439 const MemoryDepChecker &DepChecker) {
1440 // Find pointers with computable bounds. We are going to use this information
1441 // to place a runtime bound check.
1442 bool CanDoRT = true;
1443
1444 bool MayNeedRTCheck = false;
1445 if (!IsRTCheckAnalysisNeeded) return true;
1446
1447 if (auto *Deps = DepChecker.getDependences()) {
1448 // If there are unknown dependences, this means runtime checks are needed to
1449 // ensure there's no overlap between accesses to the same underlying object.
1450 // Remove the equivalence classes containing both source and destination
1451 // accesses from DepCands. This ensures runtime checks will be generated
1452 // between those accesses and prevents them from being grouped together.
1453 for (const auto &Dep : *Deps) {
1454 if (Dep.Type != MemoryDepChecker::Dependence::Unknown) {
1457 "Should only skip safe dependences");
1458 continue;
1459 }
1460 Instruction *Src = Dep.getSource(DepChecker);
1461 Instruction *Dst = Dep.getDestination(DepChecker);
1462 DepCands.eraseClass({getPointerOperand(Src), Src->mayWriteToMemory()});
1463 DepCands.eraseClass({getPointerOperand(Dst), Dst->mayWriteToMemory()});
1464 }
1465 } else {
1466 CheckDeps.clear();
1467 DepCands = {};
1468 }
1469
1470 // We assign a consecutive id to access from different alias sets.
1471 // Accesses between different groups doesn't need to be checked.
1472 unsigned ASId = 0;
1473 for (const auto &AS : AST) {
1474 int NumReadPtrChecks = 0;
1475 int NumWritePtrChecks = 0;
1476 bool CanDoAliasSetRT = true;
1477 ++ASId;
1478 auto ASPointers = AS.getPointers();
1479
1480 // We assign consecutive id to access from different dependence sets.
1481 // Accesses within the same set don't need a runtime check.
1482 unsigned RunningDepId = 1;
1484
1486
1487 // First, count how many write and read accesses are in the alias set. Also
1488 // collect MemAccessInfos for later.
1490 for (const Value *ConstPtr : ASPointers) {
1491 Value *Ptr = const_cast<Value *>(ConstPtr);
1492 bool IsWrite = Accesses.contains(MemAccessInfo(Ptr, true));
1493 if (IsWrite)
1494 ++NumWritePtrChecks;
1495 else
1496 ++NumReadPtrChecks;
1497 AccessInfos.emplace_back(Ptr, IsWrite);
1498 }
1499
1500 // We do not need runtime checks for this alias set, if there are no writes
1501 // or a single write and no reads.
1502 if (NumWritePtrChecks == 0 ||
1503 (NumWritePtrChecks == 1 && NumReadPtrChecks == 0)) {
1504 assert((ASPointers.size() <= 1 ||
1505 all_of(ASPointers,
1506 [this](const Value *Ptr) {
1507 MemAccessInfo AccessWrite(const_cast<Value *>(Ptr),
1508 true);
1509 return !DepCands.contains(AccessWrite);
1510 })) &&
1511 "Can only skip updating CanDoRT below, if all entries in AS "
1512 "are reads or there is at most 1 entry");
1513 continue;
1514 }
1515
1516 for (auto &Access : AccessInfos) {
1517 for (const auto &AccessTy : Accesses[Access]) {
1518 if (!createCheckForAccess(RtCheck, Access, AccessTy, StridesMap,
1519 DepSetId, TheLoop, RunningDepId, ASId,
1520 false)) {
1521 LLVM_DEBUG(dbgs() << "LAA: Can't find bounds for ptr:"
1522 << *Access.getPointer() << '\n');
1523 Retries.emplace_back(Access, AccessTy);
1524 CanDoAliasSetRT = false;
1525 }
1526 }
1527 }
1528
1529 // Note that this function computes CanDoRT and MayNeedRTCheck
1530 // independently. For example CanDoRT=false, MayNeedRTCheck=false means that
1531 // we have a pointer for which we couldn't find the bounds but we don't
1532 // actually need to emit any checks so it does not matter.
1533 //
1534 // We need runtime checks for this alias set, if there are at least 2
1535 // dependence sets (in which case RunningDepId > 2) or if we need to re-try
1536 // any bound checks (because in that case the number of dependence sets is
1537 // incomplete).
1538 bool NeedsAliasSetRTCheck = RunningDepId > 2 || !Retries.empty();
1539
1540 // We need to perform run-time alias checks, but some pointers had bounds
1541 // that couldn't be checked.
1542 if (NeedsAliasSetRTCheck && !CanDoAliasSetRT) {
1543 // Reset the CanDoSetRt flag and retry all accesses that have failed.
1544 // We know that we need these checks, so we can now be more aggressive
1545 // and add further checks if required (overflow checks).
1546 CanDoAliasSetRT = true;
1547 for (const auto &[Access, AccessTy] : Retries) {
1548 if (!createCheckForAccess(RtCheck, Access, AccessTy, StridesMap,
1549 DepSetId, TheLoop, RunningDepId, ASId,
1550 /*Assume=*/true)) {
1551 CanDoAliasSetRT = false;
1552 UncomputablePtr = Access.getPointer();
1553 if (!AllowPartial)
1554 break;
1555 }
1556 }
1557 }
1558
1559 CanDoRT &= CanDoAliasSetRT;
1560 MayNeedRTCheck |= NeedsAliasSetRTCheck;
1561 ++ASId;
1562 }
1563
1564 // If the pointers that we would use for the bounds comparison have different
1565 // address spaces, assume the values aren't directly comparable, so we can't
1566 // use them for the runtime check. We also have to assume they could
1567 // overlap. In the future there should be metadata for whether address spaces
1568 // are disjoint.
1569 unsigned NumPointers = RtCheck.Pointers.size();
1570 for (unsigned i = 0; i < NumPointers; ++i) {
1571 for (unsigned j = i + 1; j < NumPointers; ++j) {
1572 // Only need to check pointers between two different dependency sets.
1573 if (RtCheck.Pointers[i].DependencySetId ==
1574 RtCheck.Pointers[j].DependencySetId)
1575 continue;
1576 // Only need to check pointers in the same alias set.
1577 if (RtCheck.Pointers[i].AliasSetId != RtCheck.Pointers[j].AliasSetId)
1578 continue;
1579
1580 Value *PtrI = RtCheck.Pointers[i].PointerValue;
1581 Value *PtrJ = RtCheck.Pointers[j].PointerValue;
1582
1583 unsigned ASi = PtrI->getType()->getPointerAddressSpace();
1584 unsigned ASj = PtrJ->getType()->getPointerAddressSpace();
1585 if (ASi != ASj) {
1586 LLVM_DEBUG(
1587 dbgs() << "LAA: Runtime check would require comparison between"
1588 " different address spaces\n");
1589 return false;
1590 }
1591 }
1592 }
1593
1594 if (MayNeedRTCheck && (CanDoRT || AllowPartial))
1595 RtCheck.generateChecks(DepCands);
1596
1597 LLVM_DEBUG(dbgs() << "LAA: We need to do " << RtCheck.getNumberOfChecks()
1598 << " pointer comparisons.\n");
1599
1600 // If we can do run-time checks, but there are no checks, no runtime checks
1601 // are needed. This can happen when all pointers point to the same underlying
1602 // object for example.
1603 RtCheck.Need = CanDoRT ? RtCheck.getNumberOfChecks() != 0 : MayNeedRTCheck;
1604
1605 bool CanDoRTIfNeeded = !RtCheck.Need || CanDoRT;
1606 assert(CanDoRTIfNeeded == (CanDoRT || !MayNeedRTCheck) &&
1607 "CanDoRTIfNeeded depends on RtCheck.Need");
1608 if (!CanDoRTIfNeeded && !AllowPartial)
1609 RtCheck.reset();
1610 return CanDoRTIfNeeded;
1611}
1612
1613void AccessAnalysis::buildDependenceSets() {
1614 // We process the set twice: first we process read-write pointers, last we
1615 // process read-only pointers. This allows us to skip dependence tests for
1616 // read-only pointers.
1617
1618 LLVM_DEBUG(dbgs() << "LAA: Processing memory accesses...\n");
1619 LLVM_DEBUG(dbgs() << " AST: "; AST.dump());
1620 LLVM_DEBUG(dbgs() << "LAA: Accesses(" << Accesses.size() << "):\n");
1621 LLVM_DEBUG({
1622 for (const auto &[A, _] : Accesses)
1623 dbgs() << "\t" << *A.getPointer() << " ("
1624 << (A.getInt()
1625 ? "write"
1626 : (ReadOnlyPtr.contains(A.getPointer()) ? "read-only"
1627 : "read"))
1628 << ")\n";
1629 });
1630
1631 // The AliasSetTracker has nicely partitioned our pointers by metadata
1632 // compatibility and potential for underlying-object overlap. As a result, we
1633 // only need to check for potential pointer dependencies within each alias
1634 // set.
1635 for (const auto &AS : AST) {
1636 bool AliasSetHasWrite = false;
1637
1638 // Map of (pointer to underlying objects, accessed address space) to last
1639 // access encountered.
1640 using UnderlyingObjToAccessMap =
1642 UnderlyingObjToAccessMap ObjToLastAccess;
1643
1644 // Set of access to check after all writes have been processed.
1645 PtrAccessMap DeferredAccesses;
1646
1647 // Iterate over each alias set twice, once to process read/write pointers,
1648 // and then to process read-only pointers.
1649
1650 auto ProcessAccesses = [&](bool UseDeferred) {
1651 PtrAccessMap &S = UseDeferred ? DeferredAccesses : Accesses;
1652
1653 // Note that both the alias-set tracker and the alias sets themselves used
1654 // ordered collections internally and so the iteration order here is
1655 // deterministic.
1656 for (const Value *ConstPtr : AS.getPointers()) {
1657 Value *Ptr = const_cast<Value *>(ConstPtr);
1658
1659 // For a single memory access in AliasSetTracker, Accesses may contain
1660 // both read and write, and they both need to be handled for CheckDeps.
1661 for (auto [AccessPtr, IsWrite] : S.keys()) {
1662 if (AccessPtr != Ptr)
1663 continue;
1664
1665 // If we're using the deferred access set, then it contains only
1666 // reads.
1667 bool IsReadOnlyPtr = ReadOnlyPtr.contains(Ptr) && !IsWrite;
1668 if (UseDeferred && !IsReadOnlyPtr)
1669 continue;
1670 // Otherwise, the pointer must be in the PtrAccessSet, either as a
1671 // read or a write.
1672 assert(((IsReadOnlyPtr && UseDeferred) || IsWrite ||
1673 S.contains(MemAccessInfo(Ptr, false))) &&
1674 "Alias-set pointer not in the access set?");
1675
1676 MemAccessInfo Access(Ptr, IsWrite);
1677 DepCands.insert(Access);
1678
1679 // Memorize read-only pointers for later processing and skip them in
1680 // the first round (they need to be checked after we have seen all
1681 // write pointers). Note: we also mark pointer that are not
1682 // consecutive as "read-only" pointers (so that we check
1683 // "a[b[i]] +="). Hence, we need the second check for "!IsWrite".
1684 if (!UseDeferred && IsReadOnlyPtr) {
1685 // We only use the pointer keys, the types vector values don't
1686 // matter.
1687 DeferredAccesses.insert({Access, {}});
1688 continue;
1689 }
1690
1691 // If this is a write - check other reads and writes for conflicts. If
1692 // this is a read only check other writes for conflicts (but only if
1693 // there is no other write to the ptr - this is an optimization to
1694 // catch "a[i] = a[i] + " without having to do a dependence check).
1695 if ((IsWrite || IsReadOnlyPtr) && AliasSetHasWrite) {
1696 CheckDeps.push_back(Access);
1697 IsRTCheckAnalysisNeeded = true;
1698 }
1699
1700 if (IsWrite)
1701 AliasSetHasWrite = true;
1702
1703 // Create sets of pointers connected by a shared alias set and
1704 // underlying object.
1705 SmallVector<const Value *, 16> &UOs = UnderlyingObjects[Ptr];
1706 UOs = {};
1707 ::getUnderlyingObjects(Ptr, UOs, LI);
1709 << "Underlying objects for pointer " << *Ptr << "\n");
1710 for (const Value *UnderlyingObj : UOs) {
1711 // nullptr never alias, don't join sets for pointer that have "null"
1712 // in their UnderlyingObjects list.
1713 if (isa<ConstantPointerNull>(UnderlyingObj) &&
1715 TheLoop->getHeader()->getParent(),
1716 UnderlyingObj->getType()->getPointerAddressSpace()))
1717 continue;
1718
1719 auto [It, Inserted] = ObjToLastAccess.try_emplace(
1720 {UnderlyingObj,
1721 cast<PointerType>(Ptr->getType())->getAddressSpace()},
1722 Access);
1723 if (!Inserted) {
1724 DepCands.unionSets(Access, It->second);
1725 It->second = Access;
1726 }
1727
1728 LLVM_DEBUG(dbgs() << " " << *UnderlyingObj << "\n");
1729 }
1730 }
1731 }
1732 };
1733
1734 ProcessAccesses(false);
1735 ProcessAccesses(true);
1736 }
1737}
1738
1739/// Check whether the access through \p Ptr has a constant stride.
1740std::optional<int64_t>
1742 const Loop *Lp, const DominatorTree &DT,
1743 const SymbolicStrideMap &StridesMap, bool ShouldCheckWrap,
1745 const SCEV *PtrScev = replaceSymbolicStrideSCEV(PSE, StridesMap, Ptr);
1746 if (PSE.getSE()->isLoopInvariant(PtrScev, Lp))
1747 return 0;
1748
1749 assert(Ptr->getType()->isPointerTy() && "Unexpected non-ptr");
1750
1751 const SCEVAddRecExpr *AR = dyn_cast<SCEVAddRecExpr>(PtrScev);
1752 if (Predicates && !AR) {
1753 AR = PSE.getSE()->convertSCEVToAddRecWithPredicates(PtrScev, Lp,
1754 *Predicates);
1755 }
1756
1757 if (!AR) {
1758 LLVM_DEBUG(dbgs() << "LAA: Bad stride - Not an AddRecExpr pointer " << *Ptr
1759 << " SCEV: " << *PtrScev << "\n");
1760 return std::nullopt;
1761 }
1762
1763 std::optional<int64_t> Stride =
1764 getStrideFromAddRec(AR, Lp, AccessTy, Ptr, PSE);
1765 if (!ShouldCheckWrap || !Stride)
1766 return Stride;
1767
1768 if (isNoWrap(PSE, AR, Ptr, AccessTy, Lp, DT, Stride, Predicates))
1769 return Stride;
1770
1771 LLVM_DEBUG(
1772 dbgs() << "LAA: Bad stride - Pointer may wrap in the address space "
1773 << *Ptr << " SCEV: " << *AR << "\n");
1774 return std::nullopt;
1775}
1776
1777/// Check whether the access through \p Ptr has a constant stride.
1779 Type *AccessTy, Value *Ptr,
1780 const Loop *Lp,
1781 const DominatorTree &DT,
1782 const SymbolicStrideMap &StridesMap,
1783 bool Assume, bool ShouldCheckWrap) {
1785 std::optional<int64_t> Stride =
1786 getPtrStride(PSE, AccessTy, Ptr, Lp, DT, StridesMap, ShouldCheckWrap,
1787 Assume ? &Predicates : nullptr);
1788 PSE.addPredicates(Predicates);
1789 return Stride;
1790}
1791
1792std::optional<int64_t> llvm::getPointersDiff(Type *ElemTyA, Value *PtrA,
1793 Type *ElemTyB, Value *PtrB,
1794 const DataLayout &DL,
1795 ScalarEvolution &SE,
1796 bool StrictCheck, bool CheckType) {
1797 assert(PtrA && PtrB && "Expected non-nullptr pointers.");
1798
1799 // Make sure that A and B are different pointers.
1800 if (PtrA == PtrB)
1801 return 0;
1802
1803 // Make sure that the element types are the same if required.
1804 if (CheckType && ElemTyA != ElemTyB)
1805 return std::nullopt;
1806
1807 unsigned ASA = PtrA->getType()->getPointerAddressSpace();
1808 unsigned ASB = PtrB->getType()->getPointerAddressSpace();
1809
1810 // Check that the address spaces match.
1811 if (ASA != ASB)
1812 return std::nullopt;
1813 unsigned IdxWidth = DL.getIndexSizeInBits(ASA);
1814
1815 APInt OffsetA(IdxWidth, 0), OffsetB(IdxWidth, 0);
1816 const Value *PtrA1 = PtrA->stripAndAccumulateConstantOffsets(
1817 DL, OffsetA, /*AllowNonInbounds=*/true);
1818 const Value *PtrB1 = PtrB->stripAndAccumulateConstantOffsets(
1819 DL, OffsetB, /*AllowNonInbounds=*/true);
1820
1821 std::optional<int64_t> Val;
1822 if (PtrA1 == PtrB1) {
1823 // Retrieve the address space again as pointer stripping now tracks through
1824 // `addrspacecast`.
1825 ASA = cast<PointerType>(PtrA1->getType())->getAddressSpace();
1826 ASB = cast<PointerType>(PtrB1->getType())->getAddressSpace();
1827 // Check that the address spaces match and that the pointers are valid.
1828 if (ASA != ASB)
1829 return std::nullopt;
1830
1831 IdxWidth = DL.getIndexSizeInBits(ASA);
1832 OffsetA = OffsetA.sextOrTrunc(IdxWidth);
1833 OffsetB = OffsetB.sextOrTrunc(IdxWidth);
1834
1835 OffsetB -= OffsetA;
1836 Val = OffsetB.trySExtValue();
1837 } else {
1838 // Otherwise compute the distance with SCEV between the base pointers.
1839 const SCEV *PtrSCEVA = SE.getSCEV(PtrA);
1840 const SCEV *PtrSCEVB = SE.getSCEV(PtrB);
1841 std::optional<APInt> Diff =
1842 SE.computeConstantDifference(PtrSCEVB, PtrSCEVA);
1843 if (!Diff)
1844 return std::nullopt;
1845 Val = Diff->trySExtValue();
1846 }
1847
1848 if (!Val)
1849 return std::nullopt;
1850
1851 int64_t Size = DL.getTypeStoreSize(ElemTyA);
1852 int64_t Dist = *Val / Size;
1853
1854 // Ensure that the calculated distance matches the type-based one after all
1855 // the bitcasts removal in the provided pointers.
1856 if (!StrictCheck || Dist * Size == Val)
1857 return Dist;
1858 return std::nullopt;
1859}
1860
1862 const DataLayout &DL, ScalarEvolution &SE,
1863 SmallVectorImpl<unsigned> &SortedIndices) {
1865 VL, [](const Value *V) { return V->getType()->isPointerTy(); }) &&
1866 "Expected list of pointer operands.");
1867 // Walk over the pointers, and map each of them to an offset relative to
1868 // first pointer in the array.
1869 Value *Ptr0 = VL[0];
1870
1871 using DistOrdPair = std::pair<int64_t, unsigned>;
1872 auto Compare = llvm::less_first();
1873 std::set<DistOrdPair, decltype(Compare)> Offsets(Compare);
1874 Offsets.emplace(0, 0);
1875 bool IsConsecutive = true;
1876 for (auto [Idx, Ptr] : drop_begin(enumerate(VL))) {
1877 std::optional<int64_t> Diff =
1878 getPointersDiff(ElemTy, Ptr0, ElemTy, Ptr, DL, SE,
1879 /*StrictCheck=*/true);
1880 if (!Diff)
1881 return false;
1882
1883 // Check if the pointer with the same offset is found.
1884 int64_t Offset = *Diff;
1885 auto [It, IsInserted] = Offsets.emplace(Offset, Idx);
1886 if (!IsInserted)
1887 return false;
1888 // Consecutive order if the inserted element is the last one.
1889 IsConsecutive &= std::next(It) == Offsets.end();
1890 }
1891 SortedIndices.clear();
1892 if (!IsConsecutive) {
1893 // Fill SortedIndices array only if it is non-consecutive.
1894 SortedIndices.resize(VL.size());
1895 for (auto [Idx, Off] : enumerate(Offsets))
1896 SortedIndices[Idx] = Off.second;
1897 }
1898 return true;
1899}
1900
1901/// Returns true if the memory operations \p A and \p B are consecutive.
1903 ScalarEvolution &SE, bool CheckType) {
1906 if (!PtrA || !PtrB)
1907 return false;
1908 Type *ElemTyA = getLoadStoreType(A);
1909 Type *ElemTyB = getLoadStoreType(B);
1910 std::optional<int64_t> Diff =
1911 getPointersDiff(ElemTyA, PtrA, ElemTyB, PtrB, DL, SE,
1912 /*StrictCheck=*/true, CheckType);
1913 return Diff == 1;
1914}
1915
1917 visitPointers(SI->getPointerOperand(), *InnermostLoop,
1918 [this, SI](Value *Ptr) {
1919 Accesses[MemAccessInfo(Ptr, true)].push_back(AccessIdx);
1920 InstMap.push_back(SI);
1921 ++AccessIdx;
1922 });
1923}
1924
1926 visitPointers(LI->getPointerOperand(), *InnermostLoop,
1927 [this, LI](Value *Ptr) {
1928 Accesses[MemAccessInfo(Ptr, false)].push_back(AccessIdx);
1929 InstMap.push_back(LI);
1930 ++AccessIdx;
1931 });
1932}
1933
1953
1955 switch (Type) {
1956 case NoDep:
1957 case Forward:
1959 case Unknown:
1960 case IndirectUnsafe:
1961 case InvariantUnsafe:
1962 return false;
1963
1965 case Backward:
1967 return true;
1968 }
1969 llvm_unreachable("unexpected DepType!");
1970}
1971
1976
1978 switch (Type) {
1979 case Forward:
1981 return true;
1982
1983 case NoDep:
1984 case Unknown:
1986 case Backward:
1988 case IndirectUnsafe:
1989 case InvariantUnsafe:
1990 return false;
1991 }
1992 llvm_unreachable("unexpected DepType!");
1993}
1994
1995bool MemoryDepChecker::couldPreventStoreLoadForward(uint64_t Distance,
1996 uint64_t TypeByteSize,
1997 unsigned CommonStride) {
1998 // If loads occur at a distance that is not a multiple of a feasible vector
1999 // factor store-load forwarding does not take place.
2000 // Positive dependences might cause troubles because vectorizing them might
2001 // prevent store-load forwarding making vectorized code run a lot slower.
2002 // a[i] = a[i-3] ^ a[i-8];
2003 // The stores to a[i:i+1] don't align with the stores to a[i-3:i-2] and
2004 // hence on your typical architecture store-load forwarding does not take
2005 // place. Vectorizing in such cases does not make sense.
2006 // Store-load forwarding distance.
2007
2008 // Maximum vector factor.
2009 uint64_t MaxVFWithoutSLForwardIssuesPowerOf2 =
2010 std::min(VectorizerParams::MaxVectorWidth * TypeByteSize,
2011 MaxStoreLoadForwardSafeDistanceInBits);
2012
2013 // Compute the smallest VF at which the store and load would be misaligned
2014 // and recent enough to still be in the store buffer.
2015 for (uint64_t VF = 2 * TypeByteSize;
2016 VF <= MaxVFWithoutSLForwardIssuesPowerOf2; VF *= 2) {
2017 if (isStoreLoadForwardingConflict(Distance, VF, TypeByteSize, VF)) {
2018 MaxVFWithoutSLForwardIssuesPowerOf2 = (VF >> 1);
2019 break;
2020 }
2021 }
2022
2023 if (MaxVFWithoutSLForwardIssuesPowerOf2 < 2 * TypeByteSize) {
2024 LLVM_DEBUG(
2025 dbgs() << "LAA: Distance " << Distance
2026 << " that could cause a store-load forwarding conflict\n");
2027 return true;
2028 }
2029
2030 if (CommonStride &&
2031 MaxVFWithoutSLForwardIssuesPowerOf2 <
2032 MaxStoreLoadForwardSafeDistanceInBits &&
2033 MaxVFWithoutSLForwardIssuesPowerOf2 !=
2034 VectorizerParams::MaxVectorWidth * TypeByteSize) {
2035 uint64_t MaxVF =
2036 bit_floor(MaxVFWithoutSLForwardIssuesPowerOf2 / CommonStride);
2037 uint64_t MaxVFInBits = MaxVF * TypeByteSize * 8;
2038 MaxStoreLoadForwardSafeDistanceInBits =
2039 std::min(MaxStoreLoadForwardSafeDistanceInBits, MaxVFInBits);
2040
2041 if (MaxVF < 2) {
2042 LLVM_DEBUG(
2043 dbgs() << "LAA: strided access with Distance " << Distance
2044 << " that could cause a store-load forwarding conflict\n");
2045 return true;
2046 }
2047 }
2048 return false;
2049}
2050
2051void MemoryDepChecker::mergeInStatus(VectorizationSafetyStatus S) {
2052 if (Status < S)
2053 Status = S;
2054}
2055
2056/// Given a dependence-distance \p Dist between two memory accesses, that have
2057/// strides in the same direction whose absolute value of the maximum stride is
2058/// given in \p MaxStride, in a loop whose maximum backedge taken count is \p
2059/// MaxBTC, check if it is possible to prove statically that the dependence
2060/// distance is larger than the range that the accesses will travel through the
2061/// execution of the loop. If so, return true; false otherwise. This is useful
2062/// for example in loops such as the following (PR31098):
2063///
2064/// for (i = 0; i < D; ++i) {
2065/// = out[i];
2066/// out[i+D] =
2067/// }
2069 const SCEV &MaxBTC, const SCEV &Dist,
2070 uint64_t MaxStride) {
2071
2072 // If we can prove that
2073 // (**) |Dist| > MaxBTC * Step
2074 // where Step is the absolute stride of the memory accesses in bytes,
2075 // then there is no dependence.
2076 //
2077 // Rationale:
2078 // We basically want to check if the absolute distance (|Dist/Step|)
2079 // is >= the loop iteration count (or > MaxBTC).
2080 // This is equivalent to the Strong SIV Test (Practical Dependence Testing,
2081 // Section 4.2.1); Note, that for vectorization it is sufficient to prove
2082 // that the dependence distance is >= VF; This is checked elsewhere.
2083 // But in some cases we can prune dependence distances early, and
2084 // even before selecting the VF, and without a runtime test, by comparing
2085 // the distance against the loop iteration count. Since the vectorized code
2086 // will be executed only if LoopCount >= VF, proving distance >= LoopCount
2087 // also guarantees that distance >= VF.
2088 //
2089 const SCEV *Step = SE.getConstant(MaxBTC.getType(), MaxStride);
2090 const SCEV *Product = SE.getMulExpr(&MaxBTC, Step);
2091
2092 const SCEV *CastedDist = &Dist;
2093 const SCEV *CastedProduct = Product;
2094 uint64_t DistTypeSizeBits = DL.getTypeSizeInBits(Dist.getType());
2095 uint64_t ProductTypeSizeBits = DL.getTypeSizeInBits(Product->getType());
2096
2097 // The dependence distance can be positive/negative, so we sign extend Dist;
2098 // The multiplication of the absolute stride in bytes and the
2099 // backedgeTakenCount is non-negative, so we zero extend Product.
2100 if (DistTypeSizeBits > ProductTypeSizeBits)
2101 CastedProduct = SE.getZeroExtendExpr(Product, Dist.getType());
2102 else
2103 CastedDist = SE.getNoopOrSignExtend(&Dist, Product->getType());
2104
2105 // Is Dist - (MaxBTC * Step) > 0 ?
2106 // (If so, then we have proven (**) because |Dist| >= Dist)
2107 const SCEV *Minus = SE.getMinusSCEV(CastedDist, CastedProduct);
2108 if (SE.isKnownPositive(Minus))
2109 return true;
2110
2111 // Second try: Is -Dist - (MaxBTC * Step) > 0 ?
2112 // (If so, then we have proven (**) because |Dist| >= -1*Dist)
2113 const SCEV *NegDist = SE.getNegativeSCEV(CastedDist);
2114 Minus = SE.getMinusSCEV(NegDist, CastedProduct);
2115 return SE.isKnownPositive(Minus);
2116}
2117
2118/// Check the dependence for two accesses with the same stride \p Stride.
2119/// \p Distance is the positive distance in bytes, and \p TypeByteSize is type
2120/// size in bytes.
2121///
2122/// \returns true if they are independent.
2124 uint64_t TypeByteSize) {
2125 assert(Stride > 1 && "The stride must be greater than 1");
2126 assert(TypeByteSize > 0 && "The type size in byte must be non-zero");
2127 assert(Distance > 0 && "The distance must be non-zero");
2128
2129 // Skip if the distance is not multiple of type byte size.
2130 if (Distance % TypeByteSize)
2131 return false;
2132
2133 // No dependence if the distance is not multiple of the stride.
2134 // E.g.
2135 // for (i = 0; i < 1024 ; i += 4)
2136 // A[i+2] = A[i] + 1;
2137 //
2138 // Two accesses in memory (distance is 2, stride is 4):
2139 // | A[0] | | | | A[4] | | | |
2140 // | | | A[2] | | | | A[6] | |
2141 //
2142 // E.g.
2143 // for (i = 0; i < 1024 ; i += 3)
2144 // A[i+4] = A[i] + 1;
2145 //
2146 // Two accesses in memory (distance is 4, stride is 3):
2147 // | A[0] | | | A[3] | | | A[6] | | |
2148 // | | | | | A[4] | | | A[7] | |
2149 return Distance % Stride;
2150}
2151
2152bool MemoryDepChecker::areAccessesCompletelyBeforeOrAfter(const SCEV *Src,
2153 Type *SrcTy,
2154 const SCEV *Sink,
2155 Type *SinkTy) {
2156 const SCEV *BTC = PSE.getBackedgeTakenCount();
2157 const SCEV *SymbolicMaxBTC = PSE.getSymbolicMaxBackedgeTakenCount();
2158 ScalarEvolution &SE = *PSE.getSE();
2159 const auto &[SrcStart_, SrcEnd_] =
2160 getStartAndEndForAccess(InnermostLoop, Src, SrcTy, BTC, SymbolicMaxBTC,
2161 &SE, &PointerBounds, DT, AC, LoopGuards);
2162 if (isa<SCEVCouldNotCompute>(SrcStart_) || isa<SCEVCouldNotCompute>(SrcEnd_))
2163 return false;
2164
2165 const auto &[SinkStart_, SinkEnd_] =
2166 getStartAndEndForAccess(InnermostLoop, Sink, SinkTy, BTC, SymbolicMaxBTC,
2167 &SE, &PointerBounds, DT, AC, LoopGuards);
2168 if (isa<SCEVCouldNotCompute>(SinkStart_) ||
2169 isa<SCEVCouldNotCompute>(SinkEnd_))
2170 return false;
2171
2172 if (!LoopGuards)
2173 LoopGuards.emplace(ScalarEvolution::LoopGuards::collect(InnermostLoop, SE));
2174
2175 auto SrcEnd = SE.applyLoopGuards(SrcEnd_, *LoopGuards);
2176 auto SinkStart = SE.applyLoopGuards(SinkStart_, *LoopGuards);
2177 if (SE.isKnownPredicate(CmpInst::ICMP_ULE, SrcEnd, SinkStart))
2178 return true;
2179
2180 auto SinkEnd = SE.applyLoopGuards(SinkEnd_, *LoopGuards);
2181 auto SrcStart = SE.applyLoopGuards(SrcStart_, *LoopGuards);
2182 return SE.isKnownPredicate(CmpInst::ICMP_ULE, SinkEnd, SrcStart);
2183}
2184
2186 MemoryDepChecker::DepDistanceStrideAndSizeInfo>
2187MemoryDepChecker::getDependenceDistanceStrideAndSize(
2188 const AccessAnalysis::MemAccessInfo &A, Instruction *AInst,
2189 const AccessAnalysis::MemAccessInfo &B, Instruction *BInst) {
2190 const auto &DL = InnermostLoop->getHeader()->getDataLayout();
2191 auto &SE = *PSE.getSE();
2192 const auto &[APtr, AIsWrite] = A;
2193 const auto &[BPtr, BIsWrite] = B;
2194
2195 // Two reads are independent.
2196 if (!AIsWrite && !BIsWrite)
2198
2199 Type *ATy = getLoadStoreType(AInst);
2200 Type *BTy = getLoadStoreType(BInst);
2201
2202 // We cannot check pointers in different address spaces.
2203 if (APtr->getType()->getPointerAddressSpace() !=
2204 BPtr->getType()->getPointerAddressSpace())
2206
2208 std::optional<int64_t> StrideAPtr =
2209 getPtrStride(PSE, ATy, APtr, InnermostLoop, *DT, SymbolicStrides,
2210 /*ShouldCheckWrap=*/true, &Predicates);
2211 std::optional<int64_t> StrideBPtr =
2212 getPtrStride(PSE, BTy, BPtr, InnermostLoop, *DT, SymbolicStrides,
2213 /*ShouldCheckWrap=*/true, &Predicates);
2214 PSE.addPredicates(Predicates);
2215
2216 const SCEV *Src = PSE.getSCEV(APtr);
2217 const SCEV *Sink = PSE.getSCEV(BPtr);
2218
2219 // If the induction step is negative we have to invert source and sink of the
2220 // dependence when measuring the distance between them. We should not swap
2221 // AIsWrite with BIsWrite, as their uses expect them in program order.
2222 if (StrideAPtr && *StrideAPtr < 0) {
2223 std::swap(Src, Sink);
2224 std::swap(AInst, BInst);
2225 std::swap(ATy, BTy);
2226 std::swap(StrideAPtr, StrideBPtr);
2227 }
2228
2229 const SCEV *Dist = SE.getMinusSCEV(Sink, Src);
2230
2231 LLVM_DEBUG(dbgs() << "LAA: Src Scev: " << *Src << "Sink Scev: " << *Sink
2232 << "\n");
2233 LLVM_DEBUG(dbgs() << "LAA: Distance for " << *AInst << " to " << *BInst
2234 << ": " << *Dist << "\n");
2235
2236 // Need accesses with constant strides and the same direction for further
2237 // dependence analysis. We don't want to vectorize "A[B[i]] += ..." and
2238 // similar code or pointer arithmetic that could wrap in the address space.
2239
2240 // If either Src or Sink are not strided (i.e. not a non-wrapping AddRec) and
2241 // not loop-invariant (stride will be 0 in that case), we cannot analyze the
2242 // dependence further and also cannot generate runtime checks.
2243 if (!StrideAPtr || !StrideBPtr) {
2244 LLVM_DEBUG(dbgs() << "Pointer access with non-constant stride\n");
2246 }
2247
2248 int64_t StrideAPtrInt = *StrideAPtr;
2249 int64_t StrideBPtrInt = *StrideBPtr;
2250 LLVM_DEBUG(dbgs() << "LAA: Src induction step: " << StrideAPtrInt
2251 << " Sink induction step: " << StrideBPtrInt << "\n");
2252 // At least Src or Sink are loop invariant and the other is strided or
2253 // invariant.
2254 if (!StrideAPtrInt || !StrideBPtrInt) {
2255 // If both are loop-invariant and access the same location, we cannot
2256 // vectorize.
2257 if (!StrideAPtrInt && !StrideBPtrInt && Dist->isZero())
2259 // Otherwise, we can generate a runtime check to disambiguate the accesses.
2261 }
2262
2263 // Both Src and Sink have a constant stride, check if they are in the same
2264 // direction.
2265 if ((StrideAPtrInt > 0) != (StrideBPtrInt > 0)) {
2266 LLVM_DEBUG(
2267 dbgs() << "Pointer access with strides in different directions\n");
2269 }
2270
2271 TypeSize AStoreSz = DL.getTypeStoreSize(ATy);
2272 TypeSize BStoreSz = DL.getTypeStoreSize(BTy);
2273
2274 // If store sizes are not the same, set TypeByteSize to zero, so we can check
2275 // it in the caller isDependent.
2276 uint64_t ASz = DL.getTypeAllocSize(ATy);
2277 uint64_t BSz = DL.getTypeAllocSize(BTy);
2278 uint64_t TypeByteSize = (AStoreSz == BStoreSz) ? BSz : 0;
2279
2280 uint64_t StrideAScaled = AbsoluteValue(StrideAPtrInt) * ASz;
2281 uint64_t StrideBScaled = AbsoluteValue(StrideBPtrInt) * BSz;
2282
2283 uint64_t MaxStride = std::max(StrideAScaled, StrideBScaled);
2284
2285 std::optional<uint64_t> CommonStride;
2286 if (StrideAScaled == StrideBScaled)
2287 CommonStride = StrideAScaled;
2288
2289 // TODO: Historically, we didn't retry with runtime checks when (unscaled)
2290 // strides were different but there is no inherent reason to.
2291 if (!isa<SCEVConstant>(Dist))
2292 ShouldRetryWithRuntimeChecks |= StrideAPtrInt == StrideBPtrInt;
2293
2294 // If distance is a SCEVCouldNotCompute, return Unknown immediately.
2295 if (isa<SCEVCouldNotCompute>(Dist)) {
2296 LLVM_DEBUG(dbgs() << "LAA: Uncomputable distance.\n");
2297 return Dependence::Unknown;
2298 }
2299
2300 return DepDistanceStrideAndSizeInfo(Dist, MaxStride, CommonStride,
2301 TypeByteSize, AIsWrite, BIsWrite);
2302}
2303
2305MemoryDepChecker::isDependent(const MemAccessInfo &A, unsigned AIdx,
2306 const MemAccessInfo &B, unsigned BIdx) {
2307 assert(AIdx < BIdx && "Must pass arguments in program order");
2308
2309 // Check if we can prove that Sink only accesses memory after Src's end or
2310 // vice versa. The helper is used to perform the checks only on the exit paths
2311 // where it helps to improve the analysis result.
2312 auto CheckCompletelyBeforeOrAfter = [&]() {
2313 auto *APtr = A.getPointer();
2314 auto *BPtr = B.getPointer();
2315 Type *ATy = getLoadStoreType(InstMap[AIdx]);
2316 Type *BTy = getLoadStoreType(InstMap[BIdx]);
2317 const SCEV *Src = PSE.getSCEV(APtr);
2318 const SCEV *Sink = PSE.getSCEV(BPtr);
2319 return areAccessesCompletelyBeforeOrAfter(Src, ATy, Sink, BTy);
2320 };
2321
2322 // Get the dependence distance, stride, type size and what access writes for
2323 // the dependence between A and B.
2324 auto Res =
2325 getDependenceDistanceStrideAndSize(A, InstMap[AIdx], B, InstMap[BIdx]);
2326 if (std::holds_alternative<Dependence::DepType>(Res)) {
2327 if (std::get<Dependence::DepType>(Res) == Dependence::Unknown &&
2328 CheckCompletelyBeforeOrAfter())
2329 return Dependence::NoDep;
2330 return std::get<Dependence::DepType>(Res);
2331 }
2332
2333 auto &[Dist, MaxStride, CommonStride, TypeByteSize, AIsWrite, BIsWrite] =
2334 std::get<DepDistanceStrideAndSizeInfo>(Res);
2335 bool HasSameSize = TypeByteSize > 0;
2336
2337 ScalarEvolution &SE = *PSE.getSE();
2338 auto &DL = InnermostLoop->getHeader()->getDataLayout();
2339
2340 // If the distance between the acecsses is larger than their maximum absolute
2341 // stride multiplied by the symbolic maximum backedge taken count (which is an
2342 // upper bound of the number of iterations), the accesses are independet, i.e.
2343 // they are far enough appart that accesses won't access the same location
2344 // across all loop ierations.
2345 if (HasSameSize &&
2347 DL, SE, *(PSE.getSymbolicMaxBackedgeTakenCount()), *Dist, MaxStride))
2348 return Dependence::NoDep;
2349
2350 const APInt *APDist = nullptr;
2351 uint64_t ConstDist = 0;
2352 if (match(Dist, m_scev_APInt(APDist))) {
2353 std::optional<uint64_t> Val = APDist->abs().tryZExtValue();
2354 if (!Val) {
2355 LLVM_DEBUG(dbgs() << "LAA: Constant distance does not fit in 64 bits.\n");
2356 return Dependence::Unknown;
2357 }
2358 ConstDist = *Val;
2359 }
2360
2361 // Attempt to prove strided accesses independent.
2362 if (APDist) {
2363 // If the distance between accesses and their strides are known constants,
2364 // check whether the accesses interlace each other.
2365 if (ConstDist > 0 && CommonStride && CommonStride > 1 && HasSameSize &&
2366 areStridedAccessesIndependent(ConstDist, *CommonStride, TypeByteSize)) {
2367 LLVM_DEBUG(dbgs() << "LAA: Strided accesses are independent\n");
2368 return Dependence::NoDep;
2369 }
2370 } else {
2371 if (!LoopGuards)
2372 LoopGuards.emplace(
2373 ScalarEvolution::LoopGuards::collect(InnermostLoop, SE));
2374 Dist = SE.applyLoopGuards(Dist, *LoopGuards);
2375 }
2376
2377 // Negative distances are not plausible dependencies.
2378 if (SE.isKnownNonPositive(Dist)) {
2379 if (SE.isKnownNonNegative(Dist)) {
2380 if (HasSameSize) {
2381 // Write to the same location with the same size.
2382 return Dependence::Forward;
2383 }
2384 LLVM_DEBUG(dbgs() << "LAA: possibly zero dependence difference but "
2385 "different type sizes\n");
2386 return Dependence::Unknown;
2387 }
2388
2389 bool IsTrueDataDependence = (AIsWrite && !BIsWrite);
2390 // Check if the first access writes to a location that is read in a later
2391 // iteration, where the distance between them is not a multiple of a vector
2392 // factor and relatively small.
2393 //
2394 // NOTE: There is no need to update MaxSafeVectorWidthInBits after call to
2395 // couldPreventStoreLoadForward, even if it changed MinDepDistBytes, since a
2396 // forward dependency will allow vectorization using any width.
2397
2398 if (IsTrueDataDependence && EnableForwardingConflictDetection) {
2399 if (!ConstDist) {
2400 return CheckCompletelyBeforeOrAfter() ? Dependence::NoDep
2402 }
2403 if (!HasSameSize ||
2404 couldPreventStoreLoadForward(ConstDist, TypeByteSize)) {
2405 LLVM_DEBUG(
2406 dbgs() << "LAA: Forward but may prevent st->ld forwarding\n");
2408 }
2409 }
2410
2411 LLVM_DEBUG(dbgs() << "LAA: Dependence is negative\n");
2412 return Dependence::Forward;
2413 }
2414
2415 std::optional<int64_t> MinDistanceOpt =
2417 if (!MinDistanceOpt) {
2418 LLVM_DEBUG(dbgs() << "LAA: Minimum distance does not fit in 64 bits.\n");
2419 return Dependence::Unknown;
2420 }
2421 int64_t MinDistance = *MinDistanceOpt;
2422 // Below we only handle strictly positive distances.
2423 if (MinDistance <= 0) {
2424 return CheckCompletelyBeforeOrAfter() ? Dependence::NoDep
2426 }
2427
2428 if (!HasSameSize) {
2429 if (CheckCompletelyBeforeOrAfter())
2430 return Dependence::NoDep;
2431 LLVM_DEBUG(dbgs() << "LAA: ReadWrite-Write positive dependency with "
2432 "different type sizes\n");
2433 return Dependence::Unknown;
2434 }
2435 // Bail out early if passed-in parameters make vectorization not feasible.
2436 unsigned MinForcedFactor =
2437 std::max(1U, VectorizerParams::VectorizationFactor.getKnownMinValue());
2438 unsigned ForcedUnroll = (VectorizerParams::VectorizationInterleave ?
2440 // The minimum number of iterations for a vectorized/unrolled version.
2441 unsigned MinNumIter = std::max(MinForcedFactor * ForcedUnroll, 2U);
2442
2443 // It's not vectorizable if the distance is smaller than the minimum distance
2444 // needed for a vectroized/unrolled version. Vectorizing one iteration in
2445 // front needs MaxStride. Vectorizing the last iteration needs TypeByteSize.
2446 // (No need to plus the last gap distance).
2447 //
2448 // E.g. Assume one char is 1 byte in memory and one int is 4 bytes.
2449 // foo(int *A) {
2450 // int *B = (int *)((char *)A + 14);
2451 // for (i = 0 ; i < 1024 ; i += 2)
2452 // B[i] = A[i] + 1;
2453 // }
2454 //
2455 // Two accesses in memory (stride is 4 * 2):
2456 // | A[0] | | A[2] | | A[4] | | A[6] | |
2457 // | B[0] | | B[2] | | B[4] |
2458 //
2459 // MinDistance needs for vectorizing iterations except the last iteration:
2460 // 4 * 2 * (MinNumIter - 1). MinDistance needs for the last iteration: 4.
2461 // So the minimum distance needed is: 4 * 2 * (MinNumIter - 1) + 4.
2462 //
2463 // If MinNumIter is 2, it is vectorizable as the minimum distance needed is
2464 // 12, which is less than distance.
2465 //
2466 // If MinNumIter is 4 (Say if a user forces the vectorization factor to be 4),
2467 // the minimum distance needed is 28, which is greater than distance. It is
2468 // not safe to do vectorization.
2469 //
2470 // We use MaxStride (maximum of src and sink strides) to get a conservative
2471 // lower bound on the MinDistanceNeeded in case of different strides.
2472
2473 // We know that Dist is positive, but it may not be constant. Use the signed
2474 // minimum for computations below, as this ensures we compute the closest
2475 // possible dependence distance.
2476 uint64_t MinDistanceNeeded = MaxStride * (MinNumIter - 1) + TypeByteSize;
2477 if (MinDistanceNeeded > static_cast<uint64_t>(MinDistance)) {
2478 if (!ConstDist) {
2479 // For non-constant distances, we checked the lower bound of the
2480 // dependence distance and the distance may be larger at runtime (and safe
2481 // for vectorization). Classify it as Unknown, so we re-try with runtime
2482 // checks, unless we can prove both accesses cannot overlap.
2483 return CheckCompletelyBeforeOrAfter() ? Dependence::NoDep
2485 }
2486 LLVM_DEBUG(dbgs() << "LAA: Failure because of positive minimum distance "
2487 << MinDistance << '\n');
2488 return Dependence::Backward;
2489 }
2490
2491 // Unsafe if the minimum distance needed is greater than smallest dependence
2492 // distance distance.
2493 if (MinDistanceNeeded > MinDepDistBytes) {
2494 LLVM_DEBUG(dbgs() << "LAA: Failure because it needs at least "
2495 << MinDistanceNeeded << " size in bytes\n");
2496 return Dependence::Backward;
2497 }
2498
2499 MinDepDistBytes =
2500 std::min(static_cast<uint64_t>(MinDistance), MinDepDistBytes);
2501
2502 bool IsTrueDataDependence = (!AIsWrite && BIsWrite);
2503 if (IsTrueDataDependence && EnableForwardingConflictDetection && ConstDist &&
2504 couldPreventStoreLoadForward(MinDistance, TypeByteSize, *CommonStride))
2506
2507 uint64_t MaxVF = MinDepDistBytes / MaxStride;
2508 LLVM_DEBUG(dbgs() << "LAA: Positive min distance " << MinDistance
2509 << " with max VF = " << MaxVF << '\n');
2510
2511 uint64_t MaxVFInBits = MaxVF * TypeByteSize * 8;
2512 if (!ConstDist && MaxVFInBits < MaxTargetVectorWidthInBits) {
2513 // For non-constant distances, we checked the lower bound of the dependence
2514 // distance and the distance may be larger at runtime (and safe for
2515 // vectorization). Classify it as Unknown, so we re-try with runtime checks,
2516 // unless we can prove both accesses cannot overlap.
2517 return CheckCompletelyBeforeOrAfter() ? Dependence::NoDep
2519 }
2520
2521 if (CheckCompletelyBeforeOrAfter())
2522 return Dependence::NoDep;
2523
2524 MaxSafeVectorWidthInBits = std::min(MaxSafeVectorWidthInBits, MaxVFInBits);
2526}
2527
2529 ArrayRef<MemAccessInfo> CheckDeps) {
2530
2531 MinDepDistBytes = -1;
2533 for (MemAccessInfo CurAccess : CheckDeps) {
2534 if (Visited.contains(CurAccess))
2535 continue;
2536
2537 // Check accesses within this set.
2539 DepCands.findLeader(CurAccess);
2541 DepCands.member_end();
2542
2543 // Check every access pair.
2544 while (AI != AE) {
2545 Visited.insert(*AI);
2546 bool AIIsWrite = AI->getInt();
2547 // Reads from the same pointer don't create extra hazards, but multiple
2548 // stores do (WAW), so start from AI for writes and next(AI) for reads.
2550 (AIIsWrite ? AI : std::next(AI));
2551 while (OI != AE) {
2552 // Check every accessing instruction pair in program order.
2553 auto &Acc = Accesses[*AI];
2554 for (std::vector<unsigned>::iterator I1 = Acc.begin(), I1E = Acc.end();
2555 I1 != I1E; ++I1)
2556 // When checking for WAW (OI == AI) caused by multiple writes to the
2557 // same pointer, start I2 at the next access past I1 to avoid
2558 // self-comparison.
2559 for (std::vector<unsigned>::iterator
2560 I2 = (OI == AI ? std::next(I1) : Accesses[*OI].begin()),
2561 I2E = (OI == AI ? I1E : Accesses[*OI].end());
2562 I2 != I2E; ++I2) {
2563 auto A = std::make_pair(&*AI, *I1);
2564 auto B = std::make_pair(&*OI, *I2);
2565
2566 assert(*I1 != *I2);
2567 if (*I1 > *I2)
2568 std::swap(A, B);
2569
2571 isDependent(*A.first, A.second, *B.first, B.second);
2573
2574 // Gather dependences unless we accumulated MaxDependences
2575 // dependences. In that case return as soon as we find the first
2576 // unsafe dependence. This puts a limit on this quadratic
2577 // algorithm.
2578 if (RecordDependences) {
2579 if (Type != Dependence::NoDep)
2580 Dependences.emplace_back(A.second, B.second, Type);
2581
2582 if (Dependences.size() >= MaxDependences) {
2583 RecordDependences = false;
2584 Dependences.clear();
2586 << "Too many dependences, stopped recording\n");
2587 }
2588 }
2589 if (!RecordDependences && !isSafeForVectorization())
2590 return false;
2591 }
2592 ++OI;
2593 }
2594 ++AI;
2595 }
2596 }
2597
2598 LLVM_DEBUG(dbgs() << "Total Dependences: " << Dependences.size() << "\n");
2599 return isSafeForVectorization();
2600}
2601
2604 MemAccessInfo Access(Ptr, IsWrite);
2605 auto I = Accesses.find(Access);
2607 if (I != Accesses.end()) {
2608 transform(I->second, std::back_inserter(Insts),
2609 [&](unsigned Idx) { return this->InstMap[Idx]; });
2610 }
2611
2612 return Insts;
2613}
2614
2616 "NoDep",
2617 "Unknown",
2618 "IndirectUnsafe",
2619 "InvariantUnsafe",
2620 "Forward",
2621 "ForwardButPreventsForwarding",
2622 "Backward",
2623 "BackwardVectorizable",
2624 "BackwardVectorizableButPreventsForwarding"};
2625
2627 raw_ostream &OS, unsigned Depth,
2628 const SmallVectorImpl<Instruction *> &Instrs) const {
2629 OS.indent(Depth) << DepName[Type] << ":\n";
2630 OS.indent(Depth + 2) << *Instrs[Source] << " -> \n";
2631 OS.indent(Depth + 2) << *Instrs[Destination] << "\n";
2632}
2633
2634bool LoopAccessInfo::canAnalyzeLoop() {
2635 // We need to have a loop header.
2636 LLVM_DEBUG(dbgs() << "\nLAA: Checking a loop in '"
2637 << TheLoop->getHeader()->getParent()->getName() << "' from "
2638 << TheLoop->getLocStr() << "\n");
2639
2640 // We can only analyze innermost loops.
2641 if (!TheLoop->isInnermost()) {
2642 LLVM_DEBUG(dbgs() << "LAA: loop is not the innermost loop\n");
2643 recordAnalysis("NotInnerMostLoop") << "loop is not the innermost loop";
2644 return false;
2645 }
2646
2647 // We must have a single backedge.
2648 if (TheLoop->getNumBackEdges() != 1) {
2649 LLVM_DEBUG(
2650 dbgs() << "LAA: loop control flow is not understood by analyzer\n");
2651 recordAnalysis("CFGNotUnderstood")
2652 << "loop control flow is not understood by analyzer";
2653 return false;
2654 }
2655
2656 // ScalarEvolution needs to be able to find the symbolic max backedge taken
2657 // count, which is an upper bound on the number of loop iterations. The loop
2658 // may execute fewer iterations, if it exits via an uncountable exit.
2659 const SCEV *ExitCount = PSE->getSymbolicMaxBackedgeTakenCount();
2660 if (isa<SCEVCouldNotCompute>(ExitCount)) {
2661 recordAnalysis("CantComputeNumberOfIterations")
2662 << "could not determine number of loop iterations";
2663 LLVM_DEBUG(dbgs() << "LAA: SCEV could not compute the loop exit count.\n");
2664 return false;
2665 }
2666
2667 LLVM_DEBUG(dbgs() << "LAA: Found an analyzable loop: "
2668 << TheLoop->getHeader()->getName() << "\n");
2669 return true;
2670}
2671
2672bool LoopAccessInfo::analyzeLoop(AAResults *AA, const LoopInfo *LI,
2673 const TargetLibraryInfo *TLI,
2674 DominatorTree *DT) {
2675 // Holds the Load and Store instructions.
2678 SmallPtrSet<MDNode *, 8> LoopAliasScopes;
2679
2680 // Holds all the different accesses in the loop.
2681 unsigned NumReads = 0;
2682 unsigned NumReadWrites = 0;
2683
2684 bool HasComplexMemInst = false;
2685
2686 // A runtime check is only legal to insert if there are no convergent calls.
2687 HasConvergentOp = false;
2688
2689 PtrRtChecking->Pointers.clear();
2690 PtrRtChecking->Need = false;
2691
2692 const bool IsAnnotatedParallel = TheLoop->isAnnotatedParallel();
2693
2694 const bool EnableMemAccessVersioningOfLoop =
2696 !TheLoop->getHeader()->getParent()->hasOptSize();
2697
2698 // Traverse blocks in fixed RPOT order, regardless of their storage in the
2699 // loop info, as it may be arbitrary.
2700 LoopBlocksRPO RPOT(TheLoop);
2701 RPOT.perform(LI);
2702
2703 // Don't return early as soon as we found a memory access that cannot be
2704 // vectorize - HasConvergentOp must still be computed as it is part of LAI's
2705 // public API (used by LoopDistribute).
2706 for (BasicBlock *BB : RPOT) {
2707 // Scan the BB and collect legal loads and stores. Also detect any
2708 // convergent instructions.
2709 for (Instruction &I : *BB) {
2710 if (auto *Call = dyn_cast<CallBase>(&I)) {
2711 if (Call->isConvergent())
2712 HasConvergentOp = true;
2713 }
2714
2715 // Unsafe to vectorize and we already found a convergent operation, can
2716 // early return now.
2717 if (HasComplexMemInst && HasConvergentOp)
2718 return false;
2719
2720 // Already unsafe to vectorize; keep scanning for convergent ops.
2721 if (HasComplexMemInst)
2722 continue;
2723
2724 // Record alias scopes defined inside the loop.
2725 if (auto *Decl = dyn_cast<NoAliasScopeDeclInst>(&I))
2726 for (Metadata *Op : Decl->getScopeList()->operands())
2727 LoopAliasScopes.insert(cast<MDNode>(Op));
2728
2729 // Many math library functions read the rounding mode. We will only
2730 // vectorize a loop if it contains known function calls that don't set
2731 // the flag. Therefore, it is safe to ignore this read from memory.
2732 auto *Call = dyn_cast<CallInst>(&I);
2734 continue;
2735
2736 // If this is a load, save it. If this instruction can read from memory
2737 // but is not a load, we only allow it if it's a call to a function with a
2738 // vector mapping and no pointer arguments.
2739 if (I.mayReadFromMemory()) {
2740 auto hasPointerArgs = [](CallBase *CB) {
2741 return any_of(CB->args(), [](Value const *Arg) {
2742 return Arg->getType()->isPointerTy();
2743 });
2744 };
2745
2746 // If the function has an explicit vectorized counterpart, and does not
2747 // take output/input pointers, we can safely assume that it can be
2748 // vectorized.
2749 if (Call && !Call->isNoBuiltin() && Call->getCalledFunction() &&
2750 !hasPointerArgs(Call) && !VFDatabase::getMappings(*Call).empty())
2751 continue;
2752
2753 auto *Ld = dyn_cast<LoadInst>(&I);
2754 if (!Ld) {
2755 recordAnalysis("CantVectorizeInstruction", &I)
2756 << "instruction cannot be vectorized";
2757 HasComplexMemInst = true;
2758 continue;
2759 }
2760 if (!Ld->isSimple() && !IsAnnotatedParallel) {
2761 recordAnalysis("NonSimpleLoad", Ld)
2762 << "read with atomic ordering or volatile read";
2763 LLVM_DEBUG(dbgs() << "LAA: Found a non-simple load.\n");
2764 HasComplexMemInst = true;
2765 continue;
2766 }
2767 NumLoads++;
2768 Loads.push_back(Ld);
2769 DepChecker->addAccess(Ld);
2770 if (EnableMemAccessVersioningOfLoop)
2771 collectStridedAccess(Ld);
2772 continue;
2773 }
2774
2775 // Save 'store' instructions. Abort if other instructions write to memory.
2776 if (I.mayWriteToMemory()) {
2777 auto *St = dyn_cast<StoreInst>(&I);
2778 if (!St) {
2779 recordAnalysis("CantVectorizeInstruction", &I)
2780 << "instruction cannot be vectorized";
2781 HasComplexMemInst = true;
2782 continue;
2783 }
2784 if (!St->isSimple() && !IsAnnotatedParallel) {
2785 recordAnalysis("NonSimpleStore", St)
2786 << "write with atomic ordering or volatile write";
2787 LLVM_DEBUG(dbgs() << "LAA: Found a non-simple store.\n");
2788 HasComplexMemInst = true;
2789 continue;
2790 }
2791 NumStores++;
2792 Stores.push_back(St);
2793 DepChecker->addAccess(St);
2794 if (EnableMemAccessVersioningOfLoop)
2795 collectStridedAccess(St);
2796 }
2797 } // Next instr.
2798 } // Next block.
2799
2800 if (HasComplexMemInst)
2801 return false;
2802
2803 // Now we have two lists that hold the loads and the stores.
2804 // Next, we find the pointers that they use.
2805
2806 // Check if we see any stores. If there are no stores, then we don't
2807 // care if the pointers are *restrict*.
2808 if (!Stores.size()) {
2809 LLVM_DEBUG(dbgs() << "LAA: Found a read-only loop!\n");
2810 return true;
2811 }
2812
2814 AccessAnalysis Accesses(TheLoop, AA, LI, *DT, DepCands, *PSE,
2815 LoopAliasScopes);
2816
2817 // Holds the analyzed pointers. We don't want to call getUnderlyingObjects
2818 // multiple times on the same object. If the ptr is accessed twice, once
2819 // for read and once for write, it will only appear once (on the write
2820 // list). This is okay, since we are going to check for conflicts between
2821 // writes and between reads and writes, but not between reads and reads.
2822 SmallSet<std::pair<Value *, Type *>, 16> Seen;
2823
2824 // Record uniform store addresses to identify if we have multiple stores
2825 // to the same address.
2826 SmallPtrSet<Value *, 16> UniformStores;
2827
2828 for (StoreInst *ST : Stores) {
2829 Value *Ptr = ST->getPointerOperand();
2830
2831 if (isInvariant(Ptr)) {
2832 // Record store instructions to loop invariant addresses
2833 StoresToInvariantAddresses.push_back(ST);
2834 HasStoreStoreDependenceInvolvingLoopInvariantAddress |=
2835 !UniformStores.insert(Ptr).second;
2836 }
2837
2838 // If we did *not* see this pointer before, insert it to the read-write
2839 // list. At this phase it is only a 'write' list.
2840 Type *AccessTy = getLoadStoreType(ST);
2841 if (Seen.insert({Ptr, AccessTy}).second) {
2842 ++NumReadWrites;
2843
2844 MemoryLocation Loc = MemoryLocation::get(ST);
2845 // The TBAA metadata could have a control dependency on the predication
2846 // condition, so we cannot rely on it when determining whether or not we
2847 // need runtime pointer checks.
2848 if (blockNeedsPredication(ST->getParent(), TheLoop, DT))
2849 Loc.AATags.TBAA = nullptr;
2850
2851 // Expand forked pointers (i.e., a phi of multiple strided pointers) into
2852 // all alternatives.
2853 visitPointers(const_cast<Value *>(Loc.Ptr), *TheLoop,
2854 [&Accesses, AccessTy, Loc](Value *Ptr) {
2855 MemoryLocation NewLoc = Loc.getWithNewPtr(Ptr);
2856 Accesses.addStore(NewLoc, AccessTy);
2857 });
2858 }
2859 }
2860
2861 if (IsAnnotatedParallel) {
2862 LLVM_DEBUG(
2863 dbgs() << "LAA: A loop annotated parallel, ignore memory dependency "
2864 << "checks.\n");
2865 return true;
2866 }
2867
2868 for (LoadInst *LD : Loads) {
2869 Value *Ptr = LD->getPointerOperand();
2870 // If we did *not* see this pointer before, insert it to the read list. If
2871 // we *did* see it before, then it is already in the read-write list. This
2872 // allows us to vectorize expressions such as A[i] += x; Because the address
2873 // of A[i] is a read-write pointer. This only works if the index of A[i] is
2874 // strictly monotonic, which we approximate (conservatively) via
2875 // getPtrStride. If the address is unknown (e.g. A[B[i]]) then we may read,
2876 // modify, and write overlapping words. Note that "zero stride" is unsafe
2877 // and is being handled below.
2878 bool IsReadOnlyPtr = false;
2879 Type *AccessTy = getLoadStoreType(LD);
2880 if (Seen.insert({Ptr, AccessTy}).second ||
2881 !getPtrStride(*PSE, AccessTy, Ptr, TheLoop, *DT, SymbolicStrides, false,
2882 true)) {
2883 ++NumReads;
2884 IsReadOnlyPtr = true;
2885 }
2886
2887 // See if there is an unsafe dependency between a load to a uniform address and
2888 // store to the same uniform address.
2889 if (UniformStores.contains(Ptr)) {
2890 LLVM_DEBUG(dbgs() << "LAA: Found an unsafe dependency between a uniform "
2891 "load and uniform store to the same address!\n");
2892 HasLoadStoreDependenceInvolvingLoopInvariantAddress = true;
2893 }
2894
2895 MemoryLocation Loc = MemoryLocation::get(LD);
2896 // The TBAA metadata could have a control dependency on the predication
2897 // condition, so we cannot rely on it when determining whether or not we
2898 // need runtime pointer checks.
2899 if (blockNeedsPredication(LD->getParent(), TheLoop, DT))
2900 Loc.AATags.TBAA = nullptr;
2901
2902 // Expand forked pointers (i.e., a phi of multiple strided pointers) into
2903 // all alternatives.
2904 visitPointers(const_cast<Value *>(Loc.Ptr), *TheLoop,
2905 [&Accesses, AccessTy, Loc, IsReadOnlyPtr](Value *Ptr) {
2906 MemoryLocation NewLoc = Loc.getWithNewPtr(Ptr);
2907 Accesses.addLoad(NewLoc, AccessTy, IsReadOnlyPtr);
2908 });
2909 }
2910
2911 // If we write (or read-write) to a single destination and there are no other
2912 // reads in this loop then is it safe to vectorize: the vectorized stores
2913 // preserve ordering via replication or order-preserving @llvm.masked.scatter.
2914 if (NumReadWrites == 1 && NumReads == 0) {
2915 LLVM_DEBUG(dbgs() << "LAA: Found a write-only loop!\n");
2916 return true;
2917 }
2918
2919 // Build dependence sets and check whether we need a runtime pointer bounds
2920 // check.
2921 Accesses.buildDependenceSets();
2922
2923 // Find pointers with computable bounds. We are going to use this information
2924 // to place a runtime bound check.
2925 Value *UncomputablePtr = nullptr;
2926 HasCompletePtrRtChecking =
2927 Accesses.canCheckPtrAtRT(*PtrRtChecking, TheLoop, SymbolicStrides,
2928 UncomputablePtr, AllowPartial, getDepChecker());
2929 if (!HasCompletePtrRtChecking) {
2930 const auto *I = dyn_cast_or_null<Instruction>(UncomputablePtr);
2931 recordAnalysis("CantIdentifyArrayBounds", I)
2932 << "cannot identify array bounds";
2933 LLVM_DEBUG(dbgs() << "LAA: We can't vectorize because we can't find "
2934 << "the array bounds.\n");
2935 return false;
2936 }
2937
2938 LLVM_DEBUG(
2939 dbgs() << "LAA: May be able to perform a memory runtime check if needed.\n");
2940
2941 bool DepsAreSafe = true;
2942 if (Accesses.isDependencyCheckNeeded()) {
2943 LLVM_DEBUG(dbgs() << "LAA: Checking memory dependencies\n");
2944 DepsAreSafe =
2945 DepChecker->areDepsSafe(DepCands, Accesses.getDependenciesToCheck());
2946
2947 if (!DepsAreSafe && DepChecker->shouldRetryWithRuntimeChecks()) {
2948 LLVM_DEBUG(dbgs() << "LAA: Retrying with memory checks\n");
2949
2950 PtrRtChecking->reset();
2951 PtrRtChecking->Need = true;
2952
2953 UncomputablePtr = nullptr;
2954 HasCompletePtrRtChecking = Accesses.canCheckPtrAtRT(
2955 *PtrRtChecking, TheLoop, SymbolicStrides, UncomputablePtr,
2956 AllowPartial, getDepChecker());
2957
2958 // Check that we found the bounds for the pointer.
2959 if (!HasCompletePtrRtChecking) {
2960 auto *I = dyn_cast_or_null<Instruction>(UncomputablePtr);
2961 recordAnalysis("CantCheckMemDepsAtRunTime", I)
2962 << "cannot check memory dependencies at runtime";
2963 LLVM_DEBUG(dbgs() << "LAA: Can't vectorize with memory checks\n");
2964 return false;
2965 }
2966
2967 // Clear the dependency checks. They are no longer needed.
2968 Accesses.resetDepChecks(*DepChecker);
2969
2970 DepsAreSafe = true;
2971 }
2972 }
2973
2974 // Update the invariant address dependence flags based on dependences found
2975 // by the dep checker. Even if dependences were not recorded (too many to
2976 // track), any InvariantUnsafe dep would still have set the status to Unsafe
2977 if (const auto *Deps = DepChecker->getDependences()) {
2978 for (const auto &Dep : *Deps) {
2980 continue;
2981 Instruction *Src = Dep.getSource(*DepChecker);
2982 Instruction *Dst = Dep.getDestination(*DepChecker);
2983 if (isa<LoadInst>(Src) != isa<LoadInst>(Dst)) {
2984 HasLoadStoreDependenceInvolvingLoopInvariantAddress = true;
2985 } else {
2986 assert(isa<StoreInst>(Src) && isa<StoreInst>(Dst) &&
2987 "Expected both to be stores");
2988 HasStoreStoreDependenceInvolvingLoopInvariantAddress = true;
2989 }
2990 }
2991 }
2992
2993 if (HasConvergentOp) {
2994 recordAnalysis("CantInsertRuntimeCheckWithConvergent")
2995 << "cannot add control dependency to convergent operation";
2996 LLVM_DEBUG(dbgs() << "LAA: We can't vectorize because a runtime check "
2997 "would be needed with a convergent operation\n");
2998 return false;
2999 }
3000
3001 if (DepsAreSafe) {
3002 LLVM_DEBUG(
3003 dbgs() << "LAA: No unsafe dependent memory operations in loop. We"
3004 << (PtrRtChecking->Need ? "" : " don't")
3005 << " need runtime memory checks.\n");
3006 return true;
3007 }
3008
3009 emitUnsafeDependenceRemark();
3010 return false;
3011}
3012
3013void LoopAccessInfo::emitUnsafeDependenceRemark() {
3014 const auto *Deps = getDepChecker().getDependences();
3015 if (!Deps)
3016 return;
3017 const auto *Found =
3018 llvm::find_if(*Deps, [](const MemoryDepChecker::Dependence &D) {
3021 });
3022 if (Found == Deps->end())
3023 return;
3024 MemoryDepChecker::Dependence Dep = *Found;
3025
3026 LLVM_DEBUG(dbgs() << "LAA: unsafe dependent memory operations in loop\n");
3027
3028 // Emit remark for first unsafe dependence
3029 bool HasForcedDistribution =
3030 getBooleanLoopAttribute(TheLoop, "llvm.loop.distribute.enable");
3031
3032 const std::string Info =
3033 HasForcedDistribution
3034 ? "unsafe dependent memory operations in loop."
3035 : "unsafe dependent memory operations in loop. Use "
3036 "#pragma clang loop distribute(enable) to allow loop distribution "
3037 "to attempt to isolate the offending operations into a separate "
3038 "loop";
3039 OptimizationRemarkAnalysis &R =
3040 recordAnalysis("UnsafeDep", Dep.getDestination(getDepChecker())) << Info;
3041
3042 switch (Dep.Type) {
3046 llvm_unreachable("Unexpected dependence");
3048 R << "\nBackward loop carried data dependence.";
3049 break;
3051 R << "\nForward loop carried data dependence that prevents "
3052 "store-to-load forwarding.";
3053 break;
3055 R << "\nBackward loop carried data dependence that prevents "
3056 "store-to-load forwarding.";
3057 break;
3059 R << "\nUnsafe indirect dependence.";
3060 break;
3062 R << "\nUnsafe dependence on loop-invariant address.";
3063 break;
3065 R << "\nUnknown data dependence.";
3066 break;
3067 }
3068
3069 if (Instruction *I = Dep.getSource(getDepChecker())) {
3070 DebugLoc SourceLoc = I->getDebugLoc();
3072 SourceLoc = DD->getDebugLoc();
3073 if (SourceLoc)
3074 R << " Memory location is the same as accessed at "
3075 << ore::NV("Location", SourceLoc);
3076 }
3077}
3078
3080 const Loop *TheLoop,
3081 const DominatorTree *DT) {
3082 assert(TheLoop->contains(BB) && "Unknown block used");
3083
3084 // Blocks that do not dominate the latch need predication.
3085 const BasicBlock *Latch = TheLoop->getLoopLatch();
3086 assert(Latch && "Loop expected to have a single latch.");
3087 return !DT->dominates(BB, Latch);
3088}
3089
3091LoopAccessInfo::recordAnalysis(StringRef RemarkName, const Instruction *I) {
3092 assert(!Report && "Multiple reports generated");
3093
3094 const BasicBlock *CodeRegion = TheLoop->getHeader();
3095 DebugLoc DL = TheLoop->getStartLoc();
3096
3097 if (I) {
3098 CodeRegion = I->getParent();
3099 // If there is no debug location attached to the instruction, revert back to
3100 // using the loop's.
3101 if (I->getDebugLoc())
3102 DL = I->getDebugLoc();
3103 }
3104
3105 Report = std::make_unique<OptimizationRemarkAnalysis>(DEBUG_TYPE, RemarkName,
3106 DL, CodeRegion);
3107 return *Report;
3108}
3109
3111 auto *SE = PSE->getSE();
3112 if (TheLoop->isLoopInvariant(V))
3113 return true;
3114 if (!SE->isSCEVable(V->getType()))
3115 return false;
3116 const SCEV *S = SE->getSCEV(V);
3117 return SE->isLoopInvariant(S, TheLoop);
3118}
3119
3120/// If \p Ptr is a GEP, which has a loop-variant operand, return that operand.
3121/// Otherwise, return \p Ptr.
3123 Loop *Lp) {
3124 auto *GEP = dyn_cast<GetElementPtrInst>(Ptr);
3125 if (!GEP)
3126 return Ptr;
3127
3128 Value *V = Ptr;
3129 for (const Use &U : GEP->operands()) {
3130 if (!SE->isLoopInvariant(SE->getSCEV(U), Lp)) {
3131 if (V == Ptr)
3132 V = U;
3133 else
3134 // There must be exactly one loop-variant operand.
3135 return Ptr;
3136 }
3137 }
3138 return V;
3139}
3140
3141/// Get the stride of a pointer access in a loop. Looks for symbolic
3142/// strides "a[i*stride]". Returns the symbolic stride, or null otherwise.
3143static const SCEV *getStrideFromPointer(Value *Ptr, ScalarEvolution *SE, Loop *Lp) {
3144 auto *PtrTy = dyn_cast<PointerType>(Ptr->getType());
3145 if (!PtrTy)
3146 return nullptr;
3147
3148 // Try to remove a gep instruction to make the pointer (actually index at this
3149 // point) easier analyzable. If OrigPtr is equal to Ptr we are analyzing the
3150 // pointer, otherwise, we are analyzing the index.
3151 Value *OrigPtr = Ptr;
3152
3153 Ptr = getLoopVariantGEPOperand(Ptr, SE, Lp);
3154 const SCEV *V = SE->getSCEV(Ptr);
3155
3156 if (Ptr != OrigPtr)
3157 // Strip off casts.
3158 while (auto *C = dyn_cast<SCEVIntegralCastExpr>(V))
3159 V = C->getOperand();
3160
3162 return nullptr;
3163
3164 // Note that the restriction after this loop invariant check are only
3165 // profitability restrictions.
3166 if (!SE->isLoopInvariant(V, Lp))
3167 return nullptr;
3168
3169 // Look for the loop invariant symbolic value.
3170 if (isa<SCEVUnknown>(V))
3171 return V;
3172
3173 // Look through multiplies that scale a stride by a constant.
3175 if (auto *C = dyn_cast<SCEVIntegralCastExpr>(V))
3176 if (isa<SCEVUnknown>(C->getOperand()))
3177 return V;
3178
3179 return nullptr;
3180}
3181
3182void LoopAccessInfo::collectStridedAccess(Value *MemAccess) {
3183 Value *Ptr = getLoadStorePointerOperand(MemAccess);
3184 if (!Ptr)
3185 return;
3186
3187 // Note: getStrideFromPointer is a *profitability* heuristic. We
3188 // could broaden the scope of values returned here - to anything
3189 // which happens to be loop invariant and contributes to the
3190 // computation of an interesting IV - but we chose not to as we
3191 // don't have a cost model here, and broadening the scope exposes
3192 // far too many unprofitable cases.
3193 const SCEV *StrideExpr = getStrideFromPointer(Ptr, PSE->getSE(), TheLoop);
3194 if (!StrideExpr)
3195 return;
3196
3197 if (match(StrideExpr, m_scev_UndefOrPoison()))
3198 return;
3199
3200 LLVM_DEBUG(dbgs() << "LAA: Found a strided access that is a candidate for "
3201 "versioning:");
3202 LLVM_DEBUG(dbgs() << " Ptr: " << *Ptr << " Stride: " << *StrideExpr << "\n");
3203
3204 if (!SpeculateUnitStride) {
3205 LLVM_DEBUG(dbgs() << " Chose not to due to -laa-speculate-unit-stride\n");
3206 return;
3207 }
3208
3209 // Avoid adding the "Stride == 1" predicate when we know that
3210 // Stride >= Trip-Count. Such a predicate will effectively optimize a single
3211 // or zero iteration loop, as Trip-Count <= Stride == 1.
3212 //
3213 // TODO: We are currently not making a very informed decision on when it is
3214 // beneficial to apply stride versioning. It might make more sense that the
3215 // users of this analysis (such as the vectorizer) will trigger it, based on
3216 // their specific cost considerations; For example, in cases where stride
3217 // versioning does not help resolving memory accesses/dependences, the
3218 // vectorizer should evaluate the cost of the runtime test, and the benefit
3219 // of various possible stride specializations, considering the alternatives
3220 // of using gather/scatters (if available).
3221
3222 const SCEV *MaxBTC = PSE->getSymbolicMaxBackedgeTakenCount();
3223
3224 // Match the types so we can compare the stride and the MaxBTC.
3225 // The Stride can be positive/negative, so we sign extend Stride;
3226 // The backedgeTakenCount is non-negative, so we zero extend MaxBTC.
3227 const DataLayout &DL = TheLoop->getHeader()->getDataLayout();
3228 uint64_t StrideTypeSizeBits = DL.getTypeSizeInBits(StrideExpr->getType());
3229 uint64_t BETypeSizeBits = DL.getTypeSizeInBits(MaxBTC->getType());
3230 const SCEV *CastedStride = StrideExpr;
3231 const SCEV *CastedBECount = MaxBTC;
3232 ScalarEvolution *SE = PSE->getSE();
3233 if (BETypeSizeBits >= StrideTypeSizeBits)
3234 CastedStride = SE->getNoopOrSignExtend(StrideExpr, MaxBTC->getType());
3235 else
3236 CastedBECount = SE->getZeroExtendExpr(MaxBTC, StrideExpr->getType());
3237 const SCEV *StrideMinusBETaken = SE->getMinusSCEV(CastedStride, CastedBECount);
3238 // Since TripCount == BackEdgeTakenCount + 1, checking:
3239 // "Stride >= TripCount" is equivalent to checking:
3240 // Stride - MaxBTC> 0
3241 if (SE->isKnownPositive(StrideMinusBETaken)) {
3242 LLVM_DEBUG(
3243 dbgs() << "LAA: Stride>=TripCount; No point in versioning as the "
3244 "Stride==1 predicate will imply that the loop executes "
3245 "at most once.\n");
3246 return;
3247 }
3248 LLVM_DEBUG(dbgs() << "LAA: Found a strided access that we can version.\n");
3249
3250 // Strip back off the integer cast, and check that our result is a
3251 // SCEVUnknown as we expect.
3252 const SCEV *StrideBase = StrideExpr;
3253 if (const auto *C = dyn_cast<SCEVIntegralCastExpr>(StrideBase))
3254 StrideBase = C->getOperand();
3255 assert(SE->isLoopInvariant(StrideBase, TheLoop) &&
3256 "users of the map rely on the stride being loop invariant");
3257 SymbolicStrides[Ptr] = cast<SCEVUnknown>(StrideBase);
3258}
3259
3261 const TargetTransformInfo *TTI,
3262 const TargetLibraryInfo *TLI, AAResults *AA,
3263 DominatorTree *DT, LoopInfo *LI,
3264 AssumptionCache *AC, bool AllowPartial)
3265 : PSE(std::make_unique<PredicatedScalarEvolution>(*SE, *L)),
3266 PtrRtChecking(nullptr), TheLoop(L), AllowPartial(AllowPartial) {
3267 unsigned MaxTargetVectorWidthInBits = std::numeric_limits<unsigned>::max();
3268 if (TTI && !TTI->enableScalableVectorization())
3269 // Scale the vector width by 2 as rough estimate to also consider
3270 // interleaving.
3271 MaxTargetVectorWidthInBits =
3272 TTI->getRegisterBitWidth(TargetTransformInfo::RGK_FixedWidthVector) * 2;
3273
3274 DepChecker = std::make_unique<MemoryDepChecker>(
3275 *PSE, AC, DT, L, SymbolicStrides, MaxTargetVectorWidthInBits, LoopGuards);
3276 PtrRtChecking =
3277 std::make_unique<RuntimePointerChecking>(*DepChecker, SE, LoopGuards);
3278 if (canAnalyzeLoop())
3279 CanVecMem = analyzeLoop(AA, LI, TLI, DT);
3280}
3281
3282void LoopAccessInfo::print(raw_ostream &OS, unsigned Depth) const {
3283 if (CanVecMem) {
3284 OS.indent(Depth) << "Memory dependences are safe";
3285 const MemoryDepChecker &DC = getDepChecker();
3286 if (!DC.isSafeForAnyVectorWidth())
3287 OS << " with a maximum safe vector width of "
3288 << DC.getMaxSafeVectorWidthInBits() << " bits";
3290 uint64_t SLDist = DC.getStoreLoadForwardSafeDistanceInBits();
3291 OS << ", with a maximum safe store-load forward width of " << SLDist
3292 << " bits";
3293 }
3294 if (PtrRtChecking->Need)
3295 OS << " with run-time checks";
3296 OS << "\n";
3297 }
3298
3299 if (HasConvergentOp)
3300 OS.indent(Depth) << "Has convergent operation in loop\n";
3301
3302 if (Report)
3303 OS.indent(Depth) << "Report: " << Report->getMsg() << "\n";
3304
3305 if (auto *Dependences = DepChecker->getDependences()) {
3306 OS.indent(Depth) << "Dependences:\n";
3307 for (const auto &Dep : *Dependences) {
3308 Dep.print(OS, Depth + 2, DepChecker->getMemoryInstructions());
3309 OS << "\n";
3310 }
3311 } else
3312 OS.indent(Depth) << "Too many dependences, not recorded\n";
3313
3314 // List the pair of accesses need run-time checks to prove independence.
3315 PtrRtChecking->print(OS, Depth);
3316 if (PtrRtChecking->Need && !HasCompletePtrRtChecking)
3317 OS.indent(Depth) << "Generated run-time checks are incomplete\n";
3318 OS << "\n";
3319
3320 OS.indent(Depth)
3321 << "Non vectorizable stores to invariant address were "
3322 << (HasStoreStoreDependenceInvolvingLoopInvariantAddress ||
3323 HasLoadStoreDependenceInvolvingLoopInvariantAddress
3324 ? ""
3325 : "not ")
3326 << "found in loop.\n";
3327
3328 OS.indent(Depth) << "SCEV assumptions:\n";
3329 PSE->getPredicate().print(OS, Depth);
3330
3331 OS << "\n";
3332
3333 OS.indent(Depth) << "Expressions re-written:\n";
3334 PSE->print(OS, Depth);
3335}
3336
3338 bool AllowPartial) {
3339 const auto &[It, Inserted] = LoopAccessInfoMap.try_emplace(&L);
3340
3341 // We need to create the LoopAccessInfo if either we don't already have one,
3342 // or if it was created with a different value of AllowPartial.
3343 if (Inserted || It->second->hasAllowPartial() != AllowPartial)
3344 It->second = std::make_unique<LoopAccessInfo>(&L, &SE, TTI, TLI, &AA, &DT,
3345 &LI, AC, AllowPartial);
3346
3347 return *It->second;
3348}
3350 // Collect LoopAccessInfo entries that may keep references to IR outside the
3351 // analyzed loop or SCEVs that may have been modified or invalidated. At the
3352 // moment, that is loops requiring memory or SCEV runtime checks, as those cache
3353 // SCEVs, e.g. for pointer expressions.
3354 LoopAccessInfoMap.remove_if([](const auto &Entry) {
3355 const auto &LAI = Entry.second;
3356 return !(LAI->getRuntimePointerChecking()->getChecks().empty() &&
3357 LAI->getPSE().getPredicate().isAlwaysTrue());
3358 });
3359}
3360
3362 Function &F, const PreservedAnalyses &PA,
3363 FunctionAnalysisManager::Invalidator &Inv) {
3364 // Check whether our analysis is preserved.
3365 auto PAC = PA.getChecker<LoopAccessAnalysis>();
3366 if (!PAC.preserved() && !PAC.preservedSet<AllAnalysesOn<Function>>())
3367 // If not, give up now.
3368 return true;
3369
3370 // Check whether the analyses we depend on became invalid for any reason.
3371 // Skip checking TargetLibraryAnalysis as it is immutable and can't become
3372 // invalid.
3373 return Inv.invalidate<AAManager>(F, PA) ||
3374 Inv.invalidate<ScalarEvolutionAnalysis>(F, PA) ||
3375 Inv.invalidate<LoopAnalysis>(F, PA) ||
3376 Inv.invalidate<DominatorTreeAnalysis>(F, PA);
3377}
3378
3381 auto &SE = FAM.getResult<ScalarEvolutionAnalysis>(F);
3382 auto &AA = FAM.getResult<AAManager>(F);
3383 auto &DT = FAM.getResult<DominatorTreeAnalysis>(F);
3384 auto &LI = FAM.getResult<LoopAnalysis>(F);
3385 auto &TTI = FAM.getResult<TargetIRAnalysis>(F);
3386 auto &TLI = FAM.getResult<TargetLibraryAnalysis>(F);
3387 auto &AC = FAM.getResult<AssumptionAnalysis>(F);
3388 return LoopAccessInfoManager(SE, AA, DT, LI, &TTI, &TLI, &AC);
3389}
3390
3391AnalysisKey LoopAccessAnalysis::Key;
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...
@ Scaled
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
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< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
This file contains the declarations for the subclasses of Constant, which represent the different fla...
DXIL Forward Handle Accesses
DXIL Resource Access
dxil translate DXIL Translate Metadata
This file defines the DenseMap class.
Generic implementation of equivalence classes through the use Tarjan's efficient union-find algorithm...
#define DEBUG_TYPE
Hexagon Common GEP
#define _
This header defines various interfaces for pass management in LLVM.
static cl::opt< unsigned > MaxDependences("max-dependences", cl::Hidden, cl::desc("Maximum number of dependences collected by " "loop-access analysis (default = 100)"), cl::init(100))
We collect dependences up to this threshold.
static cl::opt< bool > EnableForwardingConflictDetection("store-to-load-forwarding-conflict-detection", cl::Hidden, cl::desc("Enable conflict detection in loop-access analysis"), cl::init(true))
Enable store-to-load forwarding conflict detection.
static void findForkedSCEVs(ScalarEvolution *SE, const Loop *L, Value *Ptr, SmallVectorImpl< PointerIntPair< const SCEV *, 1, bool > > &ScevList, unsigned Depth)
static const SCEV * mulSCEVNoOverflow(const SCEV *A, const SCEV *B, ScalarEvolution &SE)
Returns A * B, if it is guaranteed not to unsigned wrap.
static bool isNoWrap(PredicatedScalarEvolution &PSE, const SCEVAddRecExpr *AR, Value *Ptr, Type *AccessTy, const Loop *L, const DominatorTree &DT, std::optional< int64_t > Stride=std::nullopt, SmallVectorImpl< const SCEVPredicate * > *Predicates=nullptr)
Check whether AR is a non-wrapping AddRec.
static cl::opt< unsigned > MemoryCheckMergeThreshold("memory-check-merge-threshold", cl::Hidden, cl::desc("Maximum number of comparisons done when trying to merge " "runtime memory checks. (default = 100)"), cl::init(100))
The maximum iterations used to merge memory checks.
static const SCEV * getStrideFromPointer(Value *Ptr, ScalarEvolution *SE, Loop *Lp)
Get the stride of a pointer access in a loop.
static bool isKnownNonDecreasingInLoop(const SCEV *S, const Loop *L, ScalarEvolution &SE)
Return true if S is known to be monotonically non-decreasing (in the unsigned sense,...
static cl::opt< ElementCount, true > VectorizationFactor("force-vector-width", cl::Hidden, cl::desc("Sets the SIMD width. Zero is autoselect."), cl::location(VectorizerParams::VectorizationFactor))
static bool evaluatePtrAddRecAtMaxBTCWillNotWrap(const SCEVAddRecExpr *AR, const SCEV *MaxBTC, const SCEV *EltSize, ScalarEvolution &SE, const DataLayout &DL, DominatorTree *DT, AssumptionCache *AC, std::optional< ScalarEvolution::LoopGuards > &LoopGuards)
Return true, if evaluating AR at MaxBTC cannot wrap, because AR at MaxBTC is guaranteed inbounds of t...
static cl::opt< unsigned, true > VectorizationInterleave("force-vector-interleave", cl::Hidden, cl::desc("Sets the vectorization interleave count. " "Zero is autoselect."), cl::location(VectorizerParams::VectorizationInterleave))
static cl::opt< bool, true > HoistRuntimeChecks("hoist-runtime-checks", cl::Hidden, cl::desc("Hoist inner loop runtime memory checks to outer loop if possible"), cl::location(VectorizerParams::HoistRuntimeChecks), cl::init(true))
static DenseMap< const RuntimeCheckingPtrGroup *, unsigned > getPtrToIdxMap(ArrayRef< RuntimeCheckingPtrGroup > CheckingGroups)
Assign each RuntimeCheckingPtrGroup pointer an index for stable UTC output.
static cl::opt< unsigned, true > RuntimeMemoryCheckThreshold("runtime-memory-check-threshold", cl::Hidden, cl::desc("When performing memory disambiguation checks at runtime do not " "generate more than this number of comparisons (default = 8)."), cl::location(VectorizerParams::RuntimeMemoryCheckThreshold), cl::init(8))
static void visitPointers(Value *StartPtr, const Loop &InnermostLoop, function_ref< void(Value *)> AddPointer)
static bool isSafeDependenceDistance(const DataLayout &DL, ScalarEvolution &SE, const SCEV &MaxBTC, const SCEV &Dist, uint64_t MaxStride)
Given a dependence-distance Dist between two memory accesses, that have strides in the same direction...
static std::pair< const SCEV *, const SCEV * > getNonAffineMonotonicBounds(const Loop *Lp, const SCEV *PtrExpr, ScalarEvolution *SE)
Try to bound a loop-variant pointer that is not an affine AddRec.
static bool areStridedAccessesIndependent(uint64_t Distance, uint64_t Stride, uint64_t TypeByteSize)
Check the dependence for two accesses with the same stride Stride.
static const SCEV * getMinFromExprs(const SCEV *I, const SCEV *J, ScalarEvolution *SE)
Compare I and J and return the minimum.
static Value * getLoopVariantGEPOperand(Value *Ptr, ScalarEvolution *SE, Loop *Lp)
If Ptr is a GEP, which has a loop-variant operand, return that operand.
static cl::opt< unsigned > MaxForkedSCEVDepth("max-forked-scev-depth", cl::Hidden, cl::desc("Maximum recursion depth when finding forked SCEVs (default = 5)"), cl::init(5))
static cl::opt< bool > SpeculateUnitStride("laa-speculate-unit-stride", cl::Hidden, cl::desc("Speculate that non-constant strides are unit in LAA"), cl::init(true))
static cl::opt< bool > EnableMemAccessVersioning("enable-mem-access-versioning", cl::init(true), cl::Hidden, cl::desc("Enable symbolic stride memory access versioning"))
This enables versioning on the strides of symbolically striding memory accesses in code like the foll...
static const SCEV * addSCEVNoOverflow(const SCEV *A, const SCEV *B, ScalarEvolution &SE)
Returns A + B, if it is guaranteed not to unsigned wrap.
This header provides classes for managing per-loop analyses.
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
This file provides utility analysis objects describing memory locations.
#define P(N)
FunctionAnalysisManager FAM
This file defines the PointerIntPair class.
This file contains some templates that are useful if you are working with the STL at all.
This file implements a set that has insertion order iteration characteristics.
This file defines the SmallPtrSet class.
This file defines the SmallSet class.
This file defines the SmallVector class.
#define LLVM_DEBUG(...)
Definition Debug.h:119
static SymbolRef::Type getType(const Symbol *Sym)
Definition TapiFile.cpp:39
This pass exposes codegen information to IR-level passes.
static const X86InstrFMA3Group Groups[]
A manager for alias analyses.
Class for arbitrary precision integers.
Definition APInt.h:78
std::optional< uint64_t > tryZExtValue() const
Get zero extended value if possible.
Definition APInt.h:1573
APInt abs() const
Get the absolute value.
Definition APInt.h:1816
LLVM_ABI APInt sextOrTrunc(unsigned width) const
Sign extend or truncate to width.
Definition APInt.cpp:1085
std::optional< int64_t > trySExtValue() const
Get sign extended value if possible.
Definition APInt.h:1595
This templated class represents "all analyses that operate over <aparticular IR unit>" (e....
Definition Analysis.h:50
Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition ArrayRef.h:40
size_t size() const
Get the array size.
Definition ArrayRef.h:141
bool empty() const
Check if the array is empty.
Definition ArrayRef.h:136
A function analysis which provides an AssumptionCache.
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
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this basic block belongs to.
bool isNoBuiltin() const
Return true if the call should not be treated as a call to a builtin.
Function * getCalledFunction() const
Returns the function called, or null if this is an indirect function invocation or the function signa...
bool isConvergent() const
Determine if the invoke is convergent.
@ ICMP_UGE
unsigned greater or equal
Definition InstrTypes.h:764
@ ICMP_SGE
signed greater or equal
Definition InstrTypes.h:768
@ ICMP_ULE
unsigned less or equal
Definition InstrTypes.h:766
static LLVM_ABI Constant * getIntToPtr(Constant *C, Type *Ty, bool OnlyIfReduced=false)
bool isNegative() const
Definition Constants.h:214
static LLVM_ABI Constant * getAllOnesValue(Type *Ty)
A parsed version of the target data layout string in and methods for querying it.
Definition DataLayout.h:64
A debug info location.
Definition DebugLoc.h:126
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
iterator find(const_arg_type_t< KeyT > Val)
Definition DenseMap.h:223
iterator end()
Definition DenseMap.h:141
Analysis pass which computes a DominatorTree.
Definition Dominators.h:241
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree.
Definition Dominators.h:122
LLVM_ABI bool dominates(const BasicBlock *BB, const Use &U) const
Return true if the (end of the) basic block BB dominates the use U.
iterator_range< member_iterator > members(const ECValue &ECV) const
bool contains(const ElemTy &V) const
Returns true if V is contained an equivalence class.
const ECValue & insert(const ElemTy &Data)
Insert a new value into the union/find set, ignoring the request if the value already exists.
member_iterator member_end() const
const ElemTy & getLeaderValue(const ElemTy &V) const
Return the leader for the specified value that is in the set.
member_iterator findLeader(const ElemTy &V) const
Given a value in the set, return a member iterator for the equivalence class it is in.
void eraseClass(const ElemTy &V)
Erase the class containing V, i.e.
member_iterator unionSets(const ElemTy &V1, const ElemTy &V2)
Merge the two equivalence sets for the specified values, inserting them if they do not already exist ...
bool hasOptSize() const
Optimize this function for size (-Os) or minimum size (-Oz).
Definition Function.h:699
bool empty() const
Definition Function.h:844
PointerType * getType() const
Global values are always pointers.
An instruction for reading from memory.
Value * getPointerOperand()
static constexpr LocationSize beforeOrAfterPointer()
Any location before or after the base pointer (but still within the underlying object).
This analysis provides dependence information for the memory accesses of a loop.
LLVM_ABI Result run(Function &F, FunctionAnalysisManager &AM)
LLVM_ABI bool invalidate(Function &F, const PreservedAnalyses &PA, FunctionAnalysisManager::Invalidator &Inv)
LLVM_ABI const LoopAccessInfo & getInfo(Loop &L, bool AllowPartial=false)
Drive the analysis of memory accesses in the loop.
const MemoryDepChecker & getDepChecker() const
the Memory Dependence Checker which can determine the loop-independent and loop-carried dependences b...
LLVM_ABI bool isInvariant(Value *V) const
Returns true if value V is loop invariant.
LLVM_ABI void print(raw_ostream &OS, unsigned Depth=0) const
Print the information about the memory accesses in the loop.
static LLVM_ABI bool blockNeedsPredication(const BasicBlock *BB, const Loop *TheLoop, const DominatorTree *DT)
Return true if the block BB needs to be predicated in order for the loop to be vectorized.
LLVM_ABI LoopAccessInfo(Loop *L, ScalarEvolution *SE, const TargetTransformInfo *TTI, const TargetLibraryInfo *TLI, AAResults *AA, DominatorTree *DT, LoopInfo *LI, AssumptionCache *AC, bool AllowPartial=false)
Analysis pass that exposes the LoopInfo for a function.
Definition LoopInfo.h:594
bool contains(const LoopT *L) const
Return true if the specified loop is contained within this loop.
bool isInnermost() const
Return true if the loop does not contain any (natural) loops.
unsigned getNumBackEdges() const
Calculate the number of back edges to the loop header.
BlockT * getHeader() const
LoopT * getParentLoop() const
Return the parent loop if it exists or nullptr for top level loops.
Represents a single loop in the control flow graph.
Definition LoopInfo.h:40
std::string getLocStr() const
Return a string containing the debug location of the loop (file name + line number if present,...
Definition LoopInfo.cpp:730
bool isAnnotatedParallel() const
Returns true if the loop is annotated parallel.
Definition LoopInfo.cpp:628
DebugLoc getStartLoc() const
Return the debug location of the start of this loop.
Definition LoopInfo.cpp:695
ArrayRef< MDOperand > operands() const
Definition Metadata.h:1424
Checks memory dependences among accesses to the same underlying object to determine whether there vec...
ArrayRef< unsigned > getOrderForAccess(Value *Ptr, bool IsWrite) const
Return the program order indices for the access location (Ptr, IsWrite).
bool isSafeForAnyStoreLoadForwardDistances() const
Return true if there are no store-load forwarding dependencies.
LLVM_ABI bool areDepsSafe(const DepCandidates &AccessSets, ArrayRef< MemAccessInfo > CheckDeps)
Check whether the dependencies between the accesses are safe, and records the dependence information ...
bool isSafeForAnyVectorWidth() const
Return true if the number of elements that are safe to operate on simultaneously is not bounded.
static bool isStoreLoadForwardingConflict(uint64_t Distance, uint64_t VectorStoreSize, uint64_t TypeByteSize, uint64_t LoadElementSize=0)
Returns true if a memory dependence at byte distance Distance between a store (with element size Type...
PointerIntPair< Value *, 1, bool > MemAccessInfo
EquivalenceClasses< MemAccessInfo > DepCandidates
Set of potential dependent memory accesses.
bool shouldRetryWithRuntimeChecks() const
In same cases when the dependency check fails we can still vectorize the loop with a dynamic array ac...
const Loop * getInnermostLoop() const
uint64_t getMaxSafeVectorWidthInBits() const
Return the number of elements that are safe to operate on simultaneously, multiplied by the size of t...
bool isSafeForVectorization() const
No memory dependence was encountered that would inhibit vectorization.
const SmallVectorImpl< Dependence > * getDependences() const
Returns the memory dependences.
LLVM_ABI SmallVector< Instruction *, 4 > getInstructionsForAccess(Value *Ptr, bool isWrite) const
Find the set of instructions that read or write via Ptr.
VectorizationSafetyStatus
Type to keep track of the status of the dependence check.
LLVM_ABI void addAccess(StoreInst *SI)
Register the location (instructions are given increasing numbers) of a write access.
uint64_t getStoreLoadForwardSafeDistanceInBits() const
Return safe power-of-2 number of elements, which do not prevent store-load forwarding,...
Representation for a specific memory location.
static LLVM_ABI MemoryLocation get(const LoadInst *LI)
Return a location with information about the memory reference by the given instruction.
LocationSize Size
The maximum size of the location, in address-units, or UnknownSize if the size is not known.
AAMDNodes AATags
The metadata nodes which describes the aliasing of the location (each member is null if that kind of ...
const Value * Ptr
The address of the start of the location.
Diagnostic information for optimization analysis remarks.
PointerIntPair - This class implements a pair of a pointer and small integer.
An interface layer with SCEV used to manage how we see SCEV expressions for values in the context of ...
LLVM_ABI void addPredicate(const SCEVPredicate &Pred)
Adds a new predicate.
ScalarEvolution * getSE() const
Returns the ScalarEvolution analysis used.
LLVM_ABI bool hasNoOverflow(Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags)
Returns true if we've statically proved that V doesn't wrap.
LLVM_ABI const SCEVAddRecExpr * getAsAddRec(Value *V, SmallVectorImpl< const SCEVPredicate * > *WrapPredsAdded=nullptr)
Attempts to produce an AddRecExpr for V by adding additional SCEV predicates.
LLVM_ABI void addPredicates(ArrayRef< const SCEVPredicate * > Preds)
Adds all predicates in Preds.
LLVM_ABI const SCEV * getBackedgeTakenCount()
Get the (predicated) backedge count for the analyzed loop.
LLVM_ABI const SCEV * getSymbolicMaxBackedgeTakenCount()
Get the (predicated) symbolic max backedge count for the analyzed loop.
LLVM_ABI const SCEV * getSCEV(Value *V)
Returns the SCEV expression of V, in the context of the current SCEV predicate.
A set of analyses that are preserved following a run of a transformation pass.
Definition Analysis.h:112
PreservedAnalysisChecker getChecker() const
Build a checker for this PreservedAnalyses and the specified analysis type.
Definition Analysis.h:275
Holds information about the memory runtime legality checks to verify that a group of pointers do not ...
bool Need
This flag indicates if we need to add the runtime check.
void reset()
Reset the state of the pointer runtime information.
unsigned getNumberOfChecks() const
Returns the number of run-time checks required according to needsChecking.
LLVM_ABI void printChecks(raw_ostream &OS, const SmallVectorImpl< RuntimePointerCheck > &Checks, unsigned Depth=0) const
Print Checks.
LLVM_ABI bool needsChecking(const RuntimeCheckingPtrGroup &M, const RuntimeCheckingPtrGroup &N) const
Decide if we need to add a check between two groups of pointers, according to needsChecking.
LLVM_ABI void print(raw_ostream &OS, unsigned Depth=0) const
Print the list run-time memory checks necessary.
SmallVector< RuntimeCheckingPtrGroup, 2 > CheckingGroups
Holds a partitioning of pointers into "check groups".
static LLVM_ABI bool arePointersInSamePartition(const SmallVectorImpl< int > &PtrToPartition, unsigned PtrIdx1, unsigned PtrIdx2)
Check if pointers are in the same partition.
LLVM_ABI void generateChecks(MemoryDepChecker::DepCandidates &DepCands)
Generate the checks and store it.
SmallVector< PointerInfo, 2 > Pointers
Information about the pointers that may require checking.
LLVM_ABI void insert(Loop *Lp, Value *Ptr, const SCEV *PtrExpr, Type *AccessTy, bool WritePtr, unsigned DepSetId, unsigned ASId, PredicatedScalarEvolution &PSE, bool NeedsFreeze)
Insert a pointer and calculate the start and end SCEVs.
This node represents a polynomial recurrence on the trip count of the specified loop.
bool isAffine() const
Return true if this represents an expression A + B*x where A and B are loop invariant values.
SCEVUse getStepRecurrence(ScalarEvolution &SE) const
Constructs and returns the recurrence indicating how much this expression steps by.
This class represents a constant integer value.
ConstantInt * getValue() const
const APInt & getAPInt() const
NoWrapFlags getNoWrapFlags(NoWrapFlags Mask=NoWrapMask) const
This means that we are dealing with an entirely unknown SCEV value, and only represent it as its LLVM...
IncrementWrapFlags
Similar to SCEV::NoWrapFlags, but with slightly different semantics for FlagNUSW.
static SCEVWrapPredicate::IncrementWrapFlags clearFlags(SCEVWrapPredicate::IncrementWrapFlags Flags, SCEVWrapPredicate::IncrementWrapFlags OffFlags)
Convenient IncrementWrapFlags manipulation methods.
static SCEVWrapPredicate::IncrementWrapFlags getImpliedFlags(const SCEVAddRecExpr *AR, ScalarEvolution &SE)
Returns the set of SCEVWrapPredicate no wrap flags implied by a SCEVAddRecExpr.
This class represents an analyzed expression in the program.
static constexpr auto NoWrapMask
LLVM_ABI bool isZero() const
Return true if the expression is a constant zero.
Type * getType() const
Return the LLVM type of this SCEV expression.
SCEVTypes getSCEVType() const
Analysis pass that exposes the ScalarEvolution for a function.
static LLVM_ABI LoopGuards collect(const Loop *L, ScalarEvolution &SE)
Collect rewrite map for loop guards for loop L, together with flags indicating if NUW and NSW can be ...
The main scalar evolution driver.
const SCEV * getConstantMaxBackedgeTakenCount(const Loop *L)
When successful, this returns a SCEVConstant that is greater than or equal to (i.e.
LLVM_ABI bool isKnownNonNegative(const SCEV *S)
Test if the given expression is known to be non-negative.
LLVM_ABI const SCEV * getNegativeSCEV(const SCEV *V, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap)
Return the SCEV object corresponding to -V.
LLVM_ABI const SCEV * getZeroExtendExpr(SCEVUse Op, Type *Ty, unsigned Depth=0)
LLVM_ABI Type * getWiderType(Type *Ty1, Type *Ty2) const
LLVM_ABI const SCEV * getAbsExpr(const SCEV *Op, bool IsNSW)
LLVM_ABI bool isKnownNonPositive(const SCEV *S)
Test if the given expression is known to be non-positive.
LLVM_ABI bool isKnownNegative(const SCEV *S)
Test if the given expression is known to be negative.
LLVM_ABI const SCEV * getSCEVAtScope(const SCEV *S, const Loop *L)
Return a SCEV expression for the specified value at the specified scope in the program.
LLVM_ABI bool willNotOverflow(Instruction::BinaryOps BinOp, bool Signed, const SCEV *LHS, const SCEV *RHS, const Instruction *CtxI=nullptr)
Is operation BinOp between LHS and RHS provably does not have a signed/unsigned overflow (Signed)?
LLVM_ABI const SCEVPredicate * getEqualPredicate(const SCEV *LHS, const SCEV *RHS)
LLVM_ABI const SCEV * getConstant(ConstantInt *V)
LLVM_ABI const SCEV * getSCEV(Value *V)
Return a SCEV expression for the full generality of the specified expression.
LLVM_ABI const SCEV * getMinusSCEV(SCEVUse LHS, SCEVUse RHS, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap, unsigned Depth=0)
Return LHS-RHS.
LLVM_ABI const SCEV * getNoopOrSignExtend(const SCEV *V, Type *Ty)
Return a SCEV corresponding to a conversion of the input value to the specified type.
const SCEV * getOne(Type *Ty)
Return a SCEV for the constant 1 of a specific type.
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 bool isSCEVable(Type *Ty) const
Test if values of the given type are analyzable within the SCEV framework.
LLVM_ABI Type * getEffectiveSCEVType(Type *Ty) const
Return a type with the same bitwidth as the given type and which represents how SCEV will treat the g...
APInt getSignedRangeMin(const SCEV *S)
Determine the min of the signed range for a particular SCEV.
LLVM_ABI const SCEV * getUMaxExpr(SCEVUse LHS, SCEVUse RHS)
LLVM_ABI const SCEV * getStoreSizeOfExpr(Type *IntTy, Type *StoreTy)
Return an expression for the store size of StoreTy that is type IntTy.
LLVM_ABI const SCEVPredicate * getWrapPredicate(const SCEVAddRecExpr *AR, SCEVWrapPredicate::IncrementWrapFlags AddedFlags)
LLVM_ABI const SCEV * getNoopOrZeroExtend(const SCEV *V, Type *Ty)
Return a SCEV corresponding to a conversion of the input value to the specified type.
LLVM_ABI std::optional< MonotonicPredicateType > getMonotonicPredicateType(const SCEVAddRecExpr *LHS, ICmpInst::Predicate Pred)
If, for all loop invariant X, the predicate "LHS `Pred` X" is monotonically increasing or decreasing,...
LLVM_ABI const SCEV * getCouldNotCompute()
LLVM_ABI const SCEV * getMulExpr(SmallVectorImpl< SCEVUse > &Ops, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap, unsigned Depth=0)
Get a canonical multiply expression, or something simpler if possible.
LLVM_ABI const SCEV * getPointerBase(const SCEV *V)
Transitively follow the chain of pointer-type operands until reaching a SCEV that does not have a sin...
LLVM_ABI const SCEV * getAddExpr(SmallVectorImpl< SCEVUse > &Ops, SCEV::NoWrapFlags Flags=SCEV::FlagAnyWrap, unsigned Depth=0)
Get a canonical add expression, or something simpler if possible.
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,...
LLVM_ABI const SCEV * applyLoopGuards(const SCEV *Expr, const Loop *L)
Try to apply information from loop guards for L to Expr.
LLVM_ABI const SCEV * getPtrToAddrExpr(const SCEV *Op)
LLVM_ABI const SCEVAddRecExpr * convertSCEVToAddRecWithPredicates(const SCEV *S, const Loop *L, SmallVectorImpl< const SCEVPredicate * > &Preds)
Tries to convert the S expression to an AddRec expression, adding additional predicates to Preds as r...
LLVM_ABI const SCEV * getSizeOfExpr(Type *IntTy, TypeSize Size)
Return an expression for a TypeSize.
LLVM_ABI std::optional< APInt > computeConstantDifference(const SCEV *LHS, const SCEV *RHS)
Compute LHS - RHS and returns the result as an APInt if it is a constant, and std::nullopt if it isn'...
LLVM_ABI std::pair< const SCEV *, const SCEV * > SplitIntoInitAndPostInc(const Loop *L, const SCEV *S)
Splits SCEV expression S into two SCEVs.
LLVM_ABI const SCEV * getUMinExpr(SCEVUse LHS, SCEVUse RHS, bool Sequential=false)
LLVM_ABI const SCEV * getTruncateOrSignExtend(const SCEV *V, Type *Ty, unsigned Depth=0)
Return a SCEV corresponding to a conversion of the input value to the specified type.
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.
bool contains(ConstPtrType Ptr) const
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
SmallSet - This maintains a set of unique values, optimizing for the case when the set is small (less...
Definition SmallSet.h:134
bool contains(const T &V) const
Check if the SmallSet contains the given element.
Definition SmallSet.h:229
std::pair< const_iterator, bool > insert(const T &V)
insert - Insert an element into the set if it isn't already there.
Definition SmallSet.h:184
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
reference emplace_back(ArgTypes &&... Args)
void resize(size_type N)
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.
Represent a constant reference to a string, i.e.
Definition StringRef.h:56
Analysis pass providing the TargetTransformInfo.
Analysis pass providing the TargetLibraryInfo.
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.
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
bool isVectorTy() const
True if this is an instance of VectorType.
Definition Type.h:288
bool isPointerTy() const
True if this is an instance of PointerType.
Definition Type.h:282
LLVM_ABI unsigned getPointerAddressSpace() const
Get the address space of this pointer or pointer vector type.
A Use represents the edge between a Value definition and its users.
Definition Use.h:35
static SmallVector< VFInfo, 8 > getMappings(const CallInst &CI)
Retrieve all the VFInfo instances associated to the CallInst CI.
Definition VectorUtils.h:76
LLVM Value Representation.
Definition Value.h:75
Type * getType() const
All values are typed, get the type of this value.
Definition Value.h:255
LLVM_ABI const Value * stripAndAccumulateConstantOffsets(const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr, bool LookThroughIntToPtr=false) const
Accumulate the constant offset this value has compared to a base pointer.
LLVM_ABI StringRef getName() const
Return a constant reference to the value's name.
Definition Value.cpp:319
LLVM_ABI uint64_t getPointerDereferenceableBytes(const DataLayout &DL, bool &CanBeNull, bool *CanBeFreed) const
Returns the number of bytes known to be dereferenceable for the pointer value.
Definition Value.cpp:918
constexpr ScalarTy getFixedValue() const
Definition TypeSize.h:200
An efficient, type-erasing, non-owning reference to a callable.
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
raw_ostream & indent(unsigned NumSpaces)
indent - Insert 'NumSpaces' spaces.
CallInst * Call
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Abstract Attribute helper functions.
Definition Attributor.h:165
bool match(Val *V, const Pattern &P)
bind_cst_ty m_scev_APInt(const APInt *&C)
Match an SCEV constant and bind it to an APInt.
is_undef_or_poison m_scev_UndefOrPoison()
Match an SCEVUnknown wrapping undef or poison.
specificloop_ty m_SpecificLoop(const Loop *L)
match_bind< const SCEVMulExpr > m_scev_Mul(const SCEVMulExpr *&V)
specificscev_ty m_scev_Specific(const SCEV *S)
Match if we have a specific specified SCEV.
SCEVAffineAddRec_match< Op0_t, Op1_t, match_isa< const Loop > > m_scev_AffineAddRec(const Op0_t &Op0, const Op1_t &Op1)
initializer< Ty > init(const Ty &Val)
LocationClass< Ty > location(Ty &L)
DiagnosticInfoOptimizationBase::Argument NV
friend class Instruction
Iterator for Instructions in a `BasicBlock.
Definition BasicBlock.h:73
This is an optimization pass for GlobalISel generic memory operations.
LLVM_ABI std::pair< const SCEV *, const SCEV * > getStartAndEndForAccess(const Loop *Lp, const SCEV *PtrExpr, Type *AccessTy, const SCEV *BTC, const SCEV *MaxBTC, ScalarEvolution *SE, DenseMap< std::pair< const SCEV *, const SCEV * >, std::pair< const SCEV *, const SCEV * > > *PointerBounds, DominatorTree *DT, AssumptionCache *AC, std::optional< ScalarEvolution::LoopGuards > &LoopGuards)
Calculate Start and End points of memory access using exact backedge taken count BTC if computable or...
auto drop_begin(T &&RangeOrContainer, size_t N=1)
Return a range covering RangeOrContainer with the first N elements excluded.
Definition STLExtras.h:315
@ Offset
Definition DWP.cpp:577
detail::zippy< detail::zip_shortest, T, U, Args... > zip(T &&t, U &&u, Args &&...args)
zip iterator for two or more iteratable types.
Definition STLExtras.h:830
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
LLVM_ABI RetainedKnowledge getKnowledgeForValue(const Value *V, ArrayRef< Attribute::AttrKind > AttrKinds, AssumptionCache &AC, function_ref< bool(RetainedKnowledge, Instruction *, const CallBase::BundleOpInfo *)> Filter=[](auto...) { return true;})
Return a valid Knowledge associated to the Value V if its Attribute kind is in AttrKinds and it match...
LLVM_ABI bool isValidAssumeForContext(const Instruction *I, const Instruction *CxtI, const DominatorTree *DT=nullptr, bool AllowEphemerals=false)
Return true if it is valid to use the assumptions provided by an assume intrinsic,...
LLVM_ABI bool getBooleanLoopAttribute(const Loop *TheLoop, StringRef Name)
Returns true if Name is applied to TheLoop and enabled.
LLVM_ABI Intrinsic::ID getVectorIntrinsicIDForCall(const CallInst *CI, const TargetLibraryInfo *TLI)
Returns intrinsic ID for call.
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
unsigned getPointerAddressSpace(const Type *T)
Definition SPIRVUtils.h:395
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.
auto dyn_cast_if_present(const Y &Val)
dyn_cast_if_present<X> - Functionally identical to dyn_cast, except that a null (or none in the case ...
Definition Casting.h:732
LLVM_ABI const SCEV * replaceSymbolicStrideSCEV(PredicatedScalarEvolution &PSE, const SymbolicStrideMap &PtrToStride, Value *Ptr)
Return the SCEV corresponding to a pointer with the symbolic stride replaced with constant one,...
void append_range(Container &C, Range &&R)
Wrapper function to append range R to container C.
Definition STLExtras.h:2208
LLVM_ABI std::optional< int64_t > getPtrStride(PredicatedScalarEvolution &PSE, Type *AccessTy, Value *Ptr, const Loop *Lp, const DominatorTree &DT, const SymbolicStrideMap &StridesMap=SymbolicStrideMap(), bool ShouldCheckWrap=true, SmallVectorImpl< const SCEVPredicate * > *Predicates=nullptr)
If the pointer has a constant stride return it in units of the access type size.
const Value * getPointerOperand(const Value *V)
A helper function that returns the pointer operand of a load, store or GEP instruction.
RelativeUniformCounterPtr ValuesPtrExpr VTableAddr Value
Definition InstrProf.h:143
auto dyn_cast_or_null(const Y &Val)
Definition Casting.h:753
OutputIt transform(R &&Range, OutputIt d_first, UnaryFunction F)
Wrapper function around std::transform to apply a function to a range and store the result elsewhere.
Definition STLExtras.h:2026
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
decltype(auto) get(const PointerIntPair< PointerTy, IntBits, IntType, PtrTraits, Info > &Pair)
DenseMap< Value *, const SCEVUnknown * > SymbolicStrideMap
Maps a pointer to its symbolic (non-constant) stride.
LLVM_ABI bool NullPointerIsDefined(const Function *F, unsigned AS=0)
Check whether null pointer dereferencing is considered undefined behavior for a given function or an ...
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:209
LLVM_ABI std::optional< int64_t > getPointersDiff(Type *ElemTyA, Value *PtrA, Type *ElemTyB, Value *PtrB, const DataLayout &DL, ScalarEvolution &SE, bool StrictCheck=false, bool CheckType=true)
Returns the distance between the pointers PtrA and PtrB iff they are compatible and it is possible to...
LLVM_ABI bool sortPtrAccesses(ArrayRef< Value * > VL, Type *ElemTy, const DataLayout &DL, ScalarEvolution &SE, SmallVectorImpl< unsigned > &SortedIndices)
Attempt to sort the pointers in VL and return the sorted indices in SortedIndices,...
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
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.
Definition ModRef.h:74
TargetTransformInfo TTI
LLVM_ABI bool isConsecutiveAccess(Value *A, Value *B, const DataLayout &DL, ScalarEvolution &SE, bool CheckType=true)
Returns true if the memory operations A and B are consecutive.
IntPtrTy
Definition InstrProf.h:82
DWARFExpression::Operation Op
LLVM_ABI bool isGuaranteedNotToBeUndefOrPoison(const Value *V, AssumptionCache *AC=nullptr, const Instruction *CtxI=nullptr, const DominatorTree *DT=nullptr, unsigned Depth=0)
Return true if this function can prove that V does not have undef bits and is never poison.
ArrayRef(const T &OneElt) -> ArrayRef< T >
constexpr U AbsoluteValue(T X)
Return the absolute value of a signed integer, converted to the corresponding unsigned integer type.
Definition MathExtras.h:587
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
Type * getLoadStoreType(const Value *I)
A helper function that returns the type of a load or store instruction.
AnalysisManager< Function > FunctionAnalysisManager
Convenience typedef for the Function analysis manager.
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...
T bit_floor(T Value)
Returns the largest integral power of two no greater than Value if Value is nonzero.
Definition bit.h:347
LLVM_ABI void getUnderlyingObjects(const Value *V, SmallVectorImpl< const Value * > &Objects, const LoopInfo *LI=nullptr, unsigned MaxLookup=MaxLookupSearchDepth)
This method is similar to getUnderlyingObject except that it can look through phi and select instruct...
Implement std::hash so that hash_code can be used in STL containers.
Definition BitVector.h:878
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.
Definition BitVector.h:880
#define N
IR Values for the lower and upper bounds of a pointer evolution.
MDNode * Scope
The tag for alias scope specification (used with noalias).
Definition Metadata.h:786
MDNode * TBAA
The tag for type-based alias analysis.
Definition Metadata.h:780
MDNode * NoAlias
The tag specifying the noalias scope.
Definition Metadata.h:789
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition Analysis.h:29
Instruction * getDestination(const MemoryDepChecker &DepChecker) const
Return the destination instruction of the dependence.
DepType Type
The type of the dependence.
unsigned Destination
Index of the destination of the dependence in the InstMap vector.
LLVM_ABI bool isPossiblyBackward() const
May be a lexically backward dependence type (includes Unknown).
Instruction * getSource(const MemoryDepChecker &DepChecker) const
Return the source instruction of the dependence.
LLVM_ABI bool isForward() const
Lexically forward dependence.
LLVM_ABI bool isBackward() const
Lexically backward dependence.
LLVM_ABI void print(raw_ostream &OS, unsigned Depth, const SmallVectorImpl< Instruction * > &Instrs) const
Print the dependence.
unsigned Source
Index of the source of the dependence in the InstMap vector.
DepType
The type of the dependence.
static LLVM_ABI const char * DepName[]
String version of the types.
static LLVM_ABI VectorizationSafetyStatus isSafeForVectorization(DepType Type)
Dependence types that don't prevent vectorization.
Represent one information held inside an operand bundle of an llvm.assume.
unsigned AddressSpace
Address space of the involved pointers.
LLVM_ABI bool addPointer(unsigned Index, const RuntimePointerChecking &RtCheck)
Tries to add the pointer recorded in RtCheck at index Index to this pointer checking group.
bool NeedsFreeze
Whether the pointer needs to be frozen after expansion, e.g.
LLVM_ABI RuntimeCheckingPtrGroup(unsigned Index, const RuntimePointerChecking &RtCheck)
Create a new pointer checking group containing a single pointer, with index Index in RtCheck.
const SCEV * High
The SCEV expression which represents the upper bound of all the pointers in this group.
SmallVector< unsigned, 2 > Members
Indices of all the pointers that constitute this grouping.
const SCEV * Low
The SCEV expression which represents the lower bound of all the pointers in this group.
bool IsWritePtr
Holds the information if this pointer is used for writing to memory.
unsigned DependencySetId
Holds the id of the set of pointers that could be dependent because of a shared underlying object.
unsigned AliasSetId
Holds the id of the disjoint alias set to which this pointer belongs.
static LLVM_ABI const unsigned MaxVectorWidth
Maximum SIMD width.
static LLVM_ABI unsigned RuntimeMemoryCheckThreshold
\When performing memory disambiguation checks at runtime do not make more than this number of compari...
static LLVM_ABI bool isInterleaveForced()
True if force-vector-interleave was specified by the user.
static LLVM_ABI unsigned VectorizationInterleave
Interleave factor as overridden by the user.
static LLVM_ABI ElementCount VectorizationFactor
VF as overridden by the user.
static LLVM_ABI bool HoistRuntimeChecks
Function object to check whether the first component of a container supported by std::get (like std::...
Definition STLExtras.h:1439