LLVM 20.0.0git
|
Representation for a specific memory location. More...
#include "llvm/Analysis/MemoryLocation.h"
Public Types | |
enum | : uint64_t { UnknownSize = ~UINT64_C(0) } |
UnknownSize - This is a special value which can be used with the size arguments in alias queries to indicate that the caller does not know the sizes of the potential memory references. More... | |
Public Member Functions | |
void | print (raw_ostream &OS) const |
MemoryLocation () | |
MemoryLocation (const Value *Ptr, LocationSize Size, const AAMDNodes &AATags=AAMDNodes()) | |
MemoryLocation | getWithNewPtr (const Value *NewPtr) const |
MemoryLocation | getWithNewSize (LocationSize NewSize) const |
MemoryLocation | getWithoutAATags () const |
bool | operator== (const MemoryLocation &Other) const |
Static Public Member Functions | |
static MemoryLocation | get (const LoadInst *LI) |
Return a location with information about the memory reference by the given instruction. | |
static MemoryLocation | get (const StoreInst *SI) |
static MemoryLocation | get (const VAArgInst *VI) |
static MemoryLocation | get (const AtomicCmpXchgInst *CXI) |
static MemoryLocation | get (const AtomicRMWInst *RMWI) |
static MemoryLocation | get (const Instruction *Inst) |
static std::optional< MemoryLocation > | getOrNone (const Instruction *Inst) |
static MemoryLocation | getForSource (const MemTransferInst *MTI) |
Return a location representing the source of a memory transfer. | |
static MemoryLocation | getForSource (const AtomicMemTransferInst *MTI) |
static MemoryLocation | getForSource (const AnyMemTransferInst *MTI) |
static MemoryLocation | getForDest (const MemIntrinsic *MI) |
Return a location representing the destination of a memory set or transfer. | |
static MemoryLocation | getForDest (const AtomicMemIntrinsic *MI) |
static MemoryLocation | getForDest (const AnyMemIntrinsic *MI) |
static std::optional< MemoryLocation > | getForDest (const CallBase *CI, const TargetLibraryInfo &TLI) |
static MemoryLocation | getForArgument (const CallBase *Call, unsigned ArgIdx, const TargetLibraryInfo *TLI) |
Return a location representing a particular argument of a call. | |
static MemoryLocation | getForArgument (const CallBase *Call, unsigned ArgIdx, const TargetLibraryInfo &TLI) |
static MemoryLocation | getAfter (const Value *Ptr, const AAMDNodes &AATags=AAMDNodes()) |
Return a location that may access any location after Ptr, while remaining within the underlying object. | |
static MemoryLocation | getBeforeOrAfter (const Value *Ptr, const AAMDNodes &AATags=AAMDNodes()) |
Return a location that may access any location before or after Ptr, while remaining within the underlying object. | |
Public Attributes | |
const Value * | Ptr |
The address of the start of the location. | |
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 information is unavailable). | |
Representation for a specific memory location.
This abstraction can be used to represent a specific location in memory. The goal of the location is to represent enough information to describe abstract aliasing, modification, and reference behaviors of whatever value(s) are stored in memory at the particular location.
The primary user of this interface is LLVM's Alias Analysis, but other memory analyses such as MemoryDependence can use it as well.
Definition at line 228 of file MemoryLocation.h.
anonymous enum : uint64_t |
UnknownSize - This is a special value which can be used with the size arguments in alias queries to indicate that the caller does not know the sizes of the potential memory references.
Enumerator | |
---|---|
UnknownSize |
Definition at line 233 of file MemoryLocation.h.
|
inline |
Definition at line 300 of file MemoryLocation.h.
Referenced by get(), getAfter(), getBeforeOrAfter(), and getForArgument().
|
inlineexplicit |
Definition at line 302 of file MemoryLocation.h.
|
static |
Definition at line 59 of file MemoryLocation.cpp.
References DL, llvm::Instruction::getAAMetadata(), llvm::AtomicCmpXchgInst::getCompareOperand(), llvm::Instruction::getDataLayout(), llvm::AtomicCmpXchgInst::getPointerOperand(), llvm::Value::getType(), MemoryLocation(), and llvm::LocationSize::precise().
|
static |
Definition at line 68 of file MemoryLocation.cpp.
References DL, llvm::Instruction::getAAMetadata(), llvm::Instruction::getDataLayout(), llvm::AtomicRMWInst::getPointerOperand(), llvm::Value::getType(), llvm::AtomicRMWInst::getValOperand(), MemoryLocation(), and llvm::LocationSize::precise().
|
inlinestatic |
Definition at line 260 of file MemoryLocation.h.
References getOrNone().
|
static |
Return a location with information about the memory reference by the given instruction.
Definition at line 36 of file MemoryLocation.cpp.
References DL, llvm::Instruction::getAAMetadata(), llvm::Instruction::getDataLayout(), llvm::LoadInst::getPointerOperand(), llvm::Value::getType(), MemoryLocation(), and llvm::LocationSize::precise().
Referenced by llvm::AliasSetTracker::add(), canMoveAboveCall(), llvm::canSinkOrHoistInst(), canSkipClobberingStore(), llvm::DependenceInfo::depends(), findArgParts(), llvm::FindAvailableLoadedValue(), findSafeStoreForStoreStrongContraction(), foldLoadsRecursive(), GetLocation(), getLocation(), llvm::AAResults::getModRefInfo(), llvm::MemoryDependenceResults::getNonLocalPointerDependency(), getOrNone(), llvm::MemoryDependenceResults::getSimplePointerDependencyFrom(), llvm::DependenceInfo::getSplitIteration(), llvm::hasPartialIVCondition(), llvm::AMDGPU::isClobberedInFunction(), isSafeToMove(), isUseTriviallyOptimizableToLiveOnEntry(), memoryIsNotModifiedBetween(), and writeToAlloca().
|
static |
Definition at line 45 of file MemoryLocation.cpp.
References DL, MemoryLocation(), and llvm::LocationSize::precise().
|
static |
Definition at line 54 of file MemoryLocation.cpp.
References llvm::LocationSize::afterPointer(), and MemoryLocation().
|
inlinestatic |
Return a location that may access any location after Ptr, while remaining within the underlying object.
Definition at line 288 of file MemoryLocation.h.
References AATags, llvm::LocationSize::afterPointer(), MemoryLocation(), and Ptr.
Referenced by getForArgument(), GetLocation(), and llvm::MemoryDependenceResults::getSimplePointerDependencyFrom().
|
inlinestatic |
Return a location that may access any location before or after Ptr, while remaining within the underlying object.
Definition at line 296 of file MemoryLocation.h.
References AATags, llvm::LocationSize::beforeOrAfterPointer(), MemoryLocation(), and Ptr.
Referenced by addArgLocs(), llvm::objcarc::ObjCARCAAResult::alias(), llvm::AAResults::alias(), llvm::AAResults::callCapturesBefore(), getForArgument(), getForDest(), llvm::BasicAAResult::getModRefInfo(), llvm::objcarc::ObjCARCAAResult::getModRefInfoMask(), llvm::AAResults::getModRefInfoMask(), llvm::AAResults::isNoAlias(), llvm::AAResults::pointsToConstantMemory(), and underlyingObjectsAlias().
|
inlinestatic |
Definition at line 281 of file MemoryLocation.h.
References getForArgument().
|
static |
Return a location representing a particular argument of a call.
Definition at line 160 of file MemoryLocation.cpp.
References AATags, llvm::LocationSize::afterPointer(), assert(), DL, F, getAfter(), getBeforeOrAfter(), llvm::TargetLibraryInfo::getLibFunc(), llvm::TargetLibraryInfo::has(), II, MemoryLocation(), llvm::LocationSize::precise(), Size, and llvm::LocationSize::upperBound().
Referenced by llvm::AliasSetTracker::add(), getForArgument(), getForDest(), getForSource(), GetLocation(), and llvm::AAResults::getModRefInfo().
|
static |
Definition at line 116 of file MemoryLocation.cpp.
References assert(), getForArgument(), and MI.
|
static |
Definition at line 112 of file MemoryLocation.cpp.
References getForDest(), and MI.
|
static |
Definition at line 122 of file MemoryLocation.cpp.
References llvm::CallBase::arg_size(), llvm::Instruction::getAAMetadata(), llvm::CallBase::getArgOperand(), getBeforeOrAfter(), getForArgument(), llvm::Value::getType(), llvm::CallBase::hasOperandBundles(), llvm::Type::isPointerTy(), llvm::CallBase::onlyAccessesArgMemory(), and llvm::CallBase::onlyReadsMemory().
|
static |
Return a location representing the destination of a memory set or transfer.
Definition at line 108 of file MemoryLocation.cpp.
References getForDest(), and MI.
Referenced by llvm::AliasSetTracker::add(), getForDest(), llvm::AA::isPotentiallyAffectedByBarrier(), isRemovableWrite(), memoryIsNotModifiedBetween(), SoleWriteToDeadLocal(), and writeToAlloca().
|
static |
Definition at line 103 of file MemoryLocation.cpp.
References assert(), llvm::CallBase::getArgOperand(), getForArgument(), and llvm::MemTransferBase< BaseCL >::getRawSource().
|
static |
Definition at line 99 of file MemoryLocation.cpp.
References getForSource().
|
static |
Return a location representing the source of a memory transfer.
Definition at line 95 of file MemoryLocation.cpp.
References getForSource().
Referenced by llvm::AliasSetTracker::add(), getForSource(), and llvm::AA::isPotentiallyAffectedByBarrier().
|
static |
Definition at line 78 of file MemoryLocation.cpp.
References get(), and llvm::Instruction::getOpcode().
Referenced by checkFunctionMemoryAccess(), get(), HasAddressTaken(), and llvm::AA::isPotentiallyAffectedByBarrier().
|
inline |
Definition at line 306 of file MemoryLocation.h.
Referenced by memoryIsNotModifiedBetween().
|
inline |
Definition at line 312 of file MemoryLocation.h.
Referenced by foldLoadsRecursive().
|
inline |
Definition at line 318 of file MemoryLocation.h.
|
inline |
Definition at line 324 of file MemoryLocation.h.
References AATags, llvm::Other, Ptr, and Size.
|
inline |
Definition at line 251 of file MemoryLocation.h.
AAMDNodes llvm::MemoryLocation::AATags |
The metadata nodes which describes the aliasing of the location (each member is null if that kind of information is unavailable).
Definition at line 249 of file MemoryLocation.h.
Referenced by llvm::objcarc::ObjCARCAAResult::alias(), llvm::SCEVAAResult::alias(), llvm::ScopedNoAliasAAResult::alias(), llvm::TypeBasedAAResult::alias(), getAfter(), getBeforeOrAfter(), getForArgument(), llvm::DenseMapInfo< MemoryLocation >::getHashValue(), llvm::ScopedNoAliasAAResult::getModRefInfo(), llvm::TypeBasedAAResult::getModRefInfo(), llvm::objcarc::ObjCARCAAResult::getModRefInfoMask(), llvm::TypeBasedAAResult::getModRefInfoMask(), operator==(), and underlyingObjectsAlias().
The address of the start of the location.
Definition at line 236 of file MemoryLocation.h.
Referenced by addLocAccess(), llvm::BasicAAResult::alias(), llvm::GlobalsAAResult::alias(), llvm::objcarc::ObjCARCAAResult::alias(), llvm::SCEVAAResult::alias(), llvm::AMDGPUAAResult::alias(), llvm::AAResults::alias(), llvm::NVPTXAAResult::alias(), llvm::AAResults::callCapturesBefore(), llvm::findAvailablePtrLoadStore(), findDominatingValue(), findSafeStoreForStoreStrongContraction(), getAfter(), llvm::AliasSetTracker::getAliasSetFor(), getBeforeOrAfter(), llvm::MemorySSA::ClobberWalkerBase::getClobberingMemoryAccessBase(), llvm::MemoryDependenceResults::getDependency(), llvm::DenseMapInfo< MemoryLocation >::getHashValue(), llvm::BasicAAResult::getModRefInfo(), llvm::GlobalsAAResult::getModRefInfo(), llvm::AAResults::getModRefInfo(), llvm::objcarc::ObjCARCAAResult::getModRefInfoMask(), llvm::AMDGPUAAResult::getModRefInfoMask(), llvm::NVPTXAAResult::getModRefInfoMask(), llvm::BasicAAResult::getModRefInfoMask(), llvm::MemoryDependenceResults::getNonLocalPointerDependency(), llvm::AliasSet::getPointers(), llvm::MemoryDependenceResults::getSimplePointerDependencyFrom(), memoryIsNotModifiedBetween(), operator==(), llvm::AliasSet::print(), print(), and underlyingObjectsAlias().
LocationSize llvm::MemoryLocation::Size |
The maximum size of the location, in address-units, or UnknownSize if the size is not known.
Note that an unknown size does not mean the pointer aliases the entire virtual address space, because there are restrictions on stepping out of one object and into another. See http://llvm.org/docs/LangRef.html#pointeraliasing
Definition at line 245 of file MemoryLocation.h.
Referenced by llvm::BasicAAResult::alias(), llvm::objcarc::ObjCARCAAResult::alias(), llvm::SCEVAAResult::alias(), llvm::AAResults::alias(), canSkipClobberingStore(), getForArgument(), llvm::DenseMapInfo< MemoryLocation >::getHashValue(), llvm::objcarc::ObjCARCAAResult::getModRefInfoMask(), isPartialOverwrite(), operator==(), llvm::AliasSet::print(), and print().