LLVM  14.0.0git
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::RuntimePointerChecking Class Reference

Holds information about the memory runtime legality checks to verify that a group of pointers do not overlap. More...

#include "llvm/Analysis/LoopAccessAnalysis.h"

Collaboration diagram for llvm::RuntimePointerChecking:
Collaboration graph
[legend]

Classes

struct  PointerInfo
 

Public Member Functions

 RuntimePointerChecking (ScalarEvolution *SE)
 
void reset ()
 Reset the state of the pointer runtime information. More...
 
void insert (Loop *Lp, Value *Ptr, bool WritePtr, unsigned DepSetId, unsigned ASId, const ValueToValueMap &Strides, PredicatedScalarEvolution &PSE)
 Insert a pointer and calculate the start and end SCEVs. More...
 
bool empty () const
 No run-time memory checking is necessary. More...
 
void generateChecks (MemoryDepChecker::DepCandidates &DepCands, bool UseDependencies)
 Generate the checks and store it. More...
 
const SmallVectorImpl< RuntimePointerCheck > & getChecks () const
 Returns the checks that generateChecks created. More...
 
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. More...
 
unsigned getNumberOfChecks () const
 Returns the number of run-time checks required according to needsChecking. More...
 
void print (raw_ostream &OS, unsigned Depth=0) const
 Print the list run-time memory checks necessary. More...
 
void printChecks (raw_ostream &OS, const SmallVectorImpl< RuntimePointerCheck > &Checks, unsigned Depth=0) const
 Print Checks. More...
 
bool needsChecking (unsigned I, unsigned J) const
 Decide whether we need to issue a run-time check for pointer at index I and J to prove their independence. More...
 
const PointerInfogetPointerInfo (unsigned PtrIdx) const
 Return PointerInfo for pointer at index PtrIdx. More...
 
ScalarEvolutiongetSE () const
 

Static Public Member Functions

static bool arePointersInSamePartition (const SmallVectorImpl< int > &PtrToPartition, unsigned PtrIdx1, unsigned PtrIdx2)
 Check if pointers are in the same partition. More...
 

Public Attributes

bool Need
 This flag indicates if we need to add the runtime check. More...
 
SmallVector< PointerInfo, 2 > Pointers
 Information about the pointers that may require checking. More...
 
SmallVector< RuntimeCheckingPtrGroup, 2 > CheckingGroups
 Holds a partitioning of pointers into "check groups". More...
 

Friends

struct RuntimeCheckingPtrGroup
 

Detailed Description

Holds information about the memory runtime legality checks to verify that a group of pointers do not overlap.

Definition at line 368 of file LoopAccessAnalysis.h.

Constructor & Destructor Documentation

◆ RuntimePointerChecking()

llvm::RuntimePointerChecking::RuntimePointerChecking ( ScalarEvolution SE)
inline

Definition at line 399 of file LoopAccessAnalysis.h.

Member Function Documentation

◆ arePointersInSamePartition()

bool RuntimePointerChecking::arePointersInSamePartition ( const SmallVectorImpl< int > &  PtrToPartition,
unsigned  PtrIdx1,
unsigned  PtrIdx2 
)
static

Check if pointers are in the same partition.

PtrToPartition contains the partition number for pointers (-1 if the pointer belongs to multiple partitions).

Definition at line 443 of file LoopAccessAnalysis.cpp.

◆ empty()

bool llvm::RuntimePointerChecking::empty ( ) const
inline

No run-time memory checking is necessary.

Definition at line 418 of file LoopAccessAnalysis.h.

References Pointers.

◆ generateChecks()

void RuntimePointerChecking::generateChecks ( MemoryDepChecker::DepCandidates DepCands,
bool  UseDependencies 
)

Generate the checks and store it.

This also performs the grouping of pointers to reduce the number of memchecks necessary.

Definition at line 253 of file LoopAccessAnalysis.cpp.

References assert(), and generateChecks().

Referenced by generateChecks().

◆ getChecks()

const SmallVectorImpl<RuntimePointerCheck>& llvm::RuntimePointerChecking::getChecks ( ) const
inline

Returns the checks that generateChecks created.

Definition at line 426 of file LoopAccessAnalysis.h.

Referenced by llvm::InnerLoopVectorizer::emitMemRuntimeChecks().

◆ getNumberOfChecks()

unsigned llvm::RuntimePointerChecking::getNumberOfChecks ( ) const
inline

Returns the number of run-time checks required according to needsChecking.

Definition at line 437 of file LoopAccessAnalysis.h.

◆ getPointerInfo()

const PointerInfo& llvm::RuntimePointerChecking::getPointerInfo ( unsigned  PtrIdx) const
inline

Return PointerInfo for pointer at index PtrIdx.

Definition at line 469 of file LoopAccessAnalysis.h.

References Pointers.

Referenced by llvm::LoopVersioning::prepareNoAliasMetadata().

◆ getSE()

ScalarEvolution* llvm::RuntimePointerChecking::getSE ( ) const
inline

Definition at line 473 of file LoopAccessAnalysis.h.

◆ insert()

void RuntimePointerChecking::insert ( Loop Lp,
Value Ptr,
bool  WritePtr,
unsigned  DepSetId,
unsigned  ASId,
const ValueToValueMap Strides,
PredicatedScalarEvolution PSE 
)

Insert a pointer and calculate the start and end SCEVs.

Calculate Start and End points of memory access.

We need PSE in order to compute the SCEV expression of the pointer according to the assumptions that we've made during the analysis. The method might also version the pointer stride according to Strides, and add new predicates to PSE.

Let's assume A is the first access and B is a memory access on N-th loop iteration. Then B is calculated as: B = A + Step*N . Step value may be positive or negative. N is a calculated back-edge taken count: N = (TripCount > 0) ? RoundDown(TripCount -1 , VF) : 0 Start and End points are calculated in the following way: Start = UMIN(A, B) ; End = UMAX(A, B) + SizeOfElt, where SizeOfElt is the size of single memory access in bytes.

There is no conflict when the intervals are disjoint: NoConflict = (P2.Start >= P1.End) || (P1.Start >= P2.End)

Definition at line 192 of file LoopAccessAnalysis.cpp.

References assert(), DL, llvm::SCEVAddRecExpr::evaluateAtIteration(), llvm::ScalarEvolution::getAddExpr(), llvm::PredicatedScalarEvolution::getBackedgeTakenCount(), llvm::Module::getDataLayout(), llvm::LoopBase< BlockT, LoopT >::getHeader(), llvm::BasicBlock::getModule(), llvm::Type::getPointerElementType(), llvm::PredicatedScalarEvolution::getSE(), llvm::SCEVAddRecExpr::getStart(), llvm::SCEVAddRecExpr::getStepRecurrence(), llvm::ScalarEvolution::getStoreSizeOfExpr(), llvm::Value::getType(), llvm::ScalarEvolution::getUMaxExpr(), llvm::ScalarEvolution::getUMinExpr(), llvm::ScalarEvolution::isLoopInvariant(), Pointers, llvm::replaceSymbolicStrideSCEV(), and std::swap().

◆ needsChecking() [1/2]

bool RuntimePointerChecking::needsChecking ( const RuntimeCheckingPtrGroup M,
const RuntimeCheckingPtrGroup N 
) const

Decide if we need to add a check between two groups of pointers, according to needsChecking.

Definition at line 260 of file LoopAccessAnalysis.cpp.

References I, M, and N.

◆ needsChecking() [2/2]

bool RuntimePointerChecking::needsChecking ( unsigned  I,
unsigned  J 
) const

Decide whether we need to issue a run-time check for pointer at index I and J to prove their independence.

Definition at line 450 of file LoopAccessAnalysis.cpp.

References llvm::RuntimePointerChecking::PointerInfo::AliasSetId, llvm::RuntimePointerChecking::PointerInfo::DependencySetId, I, llvm::RuntimePointerChecking::PointerInfo::IsWritePtr, and Pointers.

◆ print()

void RuntimePointerChecking::print ( raw_ostream OS,
unsigned  Depth = 0 
) const

Print the list run-time memory checks necessary.

Definition at line 488 of file LoopAccessAnalysis.cpp.

References CheckingGroups, llvm::Depth, I, llvm::raw_ostream::indent(), Pointers, and printChecks().

◆ printChecks()

void RuntimePointerChecking::printChecks ( raw_ostream OS,
const SmallVectorImpl< RuntimePointerCheck > &  Checks,
unsigned  Depth = 0 
) const

Print Checks.

Definition at line 469 of file LoopAccessAnalysis.cpp.

References Check(), llvm::Depth, First, llvm::raw_ostream::indent(), N, and Pointers.

Referenced by print().

◆ reset()

void llvm::RuntimePointerChecking::reset ( )
inline

Reset the state of the pointer runtime information.

Definition at line 402 of file LoopAccessAnalysis.h.

References llvm::SmallVectorImpl< T >::clear(), Need, and Pointers.

Friends And Related Function Documentation

◆ RuntimeCheckingPtrGroup

friend struct RuntimeCheckingPtrGroup
friend

Definition at line 369 of file LoopAccessAnalysis.h.

Member Data Documentation

◆ CheckingGroups

SmallVector<RuntimeCheckingPtrGroup, 2> llvm::RuntimePointerChecking::CheckingGroups

Holds a partitioning of pointers into "check groups".

Definition at line 454 of file LoopAccessAnalysis.h.

Referenced by llvm::LoopVersioning::prepareNoAliasMetadata(), and print().

◆ Need

bool llvm::RuntimePointerChecking::Need

◆ Pointers

SmallVector<PointerInfo, 2> llvm::RuntimePointerChecking::Pointers

Information about the pointers that may require checking.

Definition at line 451 of file LoopAccessAnalysis.h.

Referenced by llvm::RuntimeCheckingPtrGroup::addPointer(), empty(), getPointerInfo(), insert(), needsChecking(), print(), printChecks(), and reset().


The documentation for this class was generated from the following files: