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).

Detailed Description

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 227 of file MemoryLocation.h.

Member Enumeration Documentation

◆ anonymous enum

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 232 of file MemoryLocation.h.

Constructor & Destructor Documentation

◆ MemoryLocation() [1/2]

llvm::MemoryLocation::MemoryLocation ( )

inline

Definition at line 299 of file MemoryLocation.h.

Referenced by get(), getAfter(), getBeforeOrAfter(), and getForArgument().

◆ MemoryLocation() [2/2]

llvm::MemoryLocation::MemoryLocation	(	const Value *	Ptr,
		LocationSize	Size,
		const AAMDNodes &	AATags = `AAMDNodes()`
	)

inlineexplicit

Definition at line 301 of file MemoryLocation.h.

Member Function Documentation

◆ get() [1/6]

MemoryLocation MemoryLocation::get ( const AtomicCmpXchgInst * CXI )

static

Definition at line 58 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().

◆ get() [2/6]

MemoryLocation MemoryLocation::get ( const AtomicRMWInst * RMWI )

static

Definition at line 67 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().

◆ get() [3/6]

static MemoryLocation llvm::MemoryLocation::get ( const Instruction * Inst )

inlinestatic

Definition at line 259 of file MemoryLocation.h.

References getOrNone().

◆ get() [4/6]

MemoryLocation MemoryLocation::get ( const LoadInst * LI )

static

Return a location with information about the memory reference by the given instruction.

Definition at line 35 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(), collectMemAccessInfo(), 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().

◆ get() [5/6]

MemoryLocation MemoryLocation::get ( const StoreInst * SI )

static

Definition at line 44 of file MemoryLocation.cpp.

References DL, MemoryLocation(), and llvm::LocationSize::precise().

◆ get() [6/6]

MemoryLocation MemoryLocation::get ( const VAArgInst * VI )

static

Definition at line 53 of file MemoryLocation.cpp.

References llvm::LocationSize::afterPointer(), and MemoryLocation().

◆ getAfter()

static MemoryLocation llvm::MemoryLocation::getAfter	(	const Value *	Ptr,
		const AAMDNodes &	AATags = `AAMDNodes()`
	)

inlinestatic

Return a location that may access any location after Ptr, while remaining within the underlying object.

Definition at line 287 of file MemoryLocation.h.

References AATags, llvm::LocationSize::afterPointer(), MemoryLocation(), and Ptr.

Referenced by getForArgument(), GetLocation(), and llvm::MemoryDependenceResults::getSimplePointerDependencyFrom().

◆ getBeforeOrAfter()

static MemoryLocation llvm::MemoryLocation::getBeforeOrAfter	(	const Value *	Ptr,
		const AAMDNodes &	AATags = `AAMDNodes()`
	)

inlinestatic

Return a location that may access any location before or after Ptr, while remaining within the underlying object.

Definition at line 295 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().

◆ getForArgument() [1/2]

static MemoryLocation llvm::MemoryLocation::getForArgument	(	const CallBase *	Call,
		unsigned	ArgIdx,
		const TargetLibraryInfo &	TLI
	)

inlinestatic

Definition at line 280 of file MemoryLocation.h.

References getForArgument().

◆ getForArgument() [2/2]

MemoryLocation MemoryLocation::getForArgument	(	const CallBase *	Call,
		unsigned	ArgIdx,
		const TargetLibraryInfo *	TLI
	)

static

Return a location representing a particular argument of a call.

Definition at line 159 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(), llvm::AAResults::getModRefInfo(), and isArgUnmodifiedByAllCalls().

◆ getForDest() [1/4]

MemoryLocation MemoryLocation::getForDest ( const AnyMemIntrinsic * MI )

static

Definition at line 115 of file MemoryLocation.cpp.

References assert(), getForArgument(), and MI.

◆ getForDest() [2/4]

MemoryLocation MemoryLocation::getForDest ( const AtomicMemIntrinsic * MI )

static

Definition at line 111 of file MemoryLocation.cpp.

References getForDest(), and MI.

◆ getForDest() [3/4]

std::optional< MemoryLocation > MemoryLocation::getForDest	(	const CallBase *	CI,
		const TargetLibraryInfo &	TLI
	)

static

Definition at line 121 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().

◆ getForDest() [4/4]

MemoryLocation MemoryLocation::getForDest ( const MemIntrinsic * MI )

static

Return a location representing the destination of a memory set or transfer.

Definition at line 107 of file MemoryLocation.cpp.

References getForDest(), and MI.

Referenced by llvm::AliasSetTracker::add(), getForDest(), llvm::AA::isPotentiallyAffectedByBarrier(), isRemovableWrite(), memoryIsNotModifiedBetween(), SoleWriteToDeadLocal(), and writeToAlloca().

◆ getForSource() [1/3]

MemoryLocation MemoryLocation::getForSource ( const AnyMemTransferInst * MTI )

static

Definition at line 102 of file MemoryLocation.cpp.

References assert(), llvm::CallBase::getArgOperand(), getForArgument(), and llvm::MemTransferBase< BaseCL >::getRawSource().

◆ getForSource() [2/3]

MemoryLocation MemoryLocation::getForSource ( const AtomicMemTransferInst * MTI )

static

Definition at line 98 of file MemoryLocation.cpp.

References getForSource().

◆ getForSource() [3/3]

MemoryLocation MemoryLocation::getForSource ( const MemTransferInst * MTI )

static

Return a location representing the source of a memory transfer.

Definition at line 94 of file MemoryLocation.cpp.

References getForSource().

Referenced by llvm::AliasSetTracker::add(), getForSource(), and llvm::AA::isPotentiallyAffectedByBarrier().

◆ getOrNone()

std::optional< MemoryLocation > MemoryLocation::getOrNone ( const Instruction * Inst )

static

Definition at line 77 of file MemoryLocation.cpp.

References get(), and llvm::Instruction::getOpcode().

Referenced by checkFunctionMemoryAccess(), get(), HasAddressTaken(), llvm::AA::isPotentiallyAffectedByBarrier(), and llvm::sandboxir::Utils::memoryLocationGetOrNone().

◆ getWithNewPtr()

MemoryLocation llvm::MemoryLocation::getWithNewPtr ( const Value * NewPtr ) const

inline

Definition at line 305 of file MemoryLocation.h.

Referenced by memoryIsNotModifiedBetween().

◆ getWithNewSize()

MemoryLocation llvm::MemoryLocation::getWithNewSize ( LocationSize NewSize ) const

inline

Definition at line 311 of file MemoryLocation.h.

Referenced by foldLoadsRecursive().

◆ getWithoutAATags()

MemoryLocation llvm::MemoryLocation::getWithoutAATags ( ) const

inline

Definition at line 317 of file MemoryLocation.h.

◆ operator==()

bool llvm::MemoryLocation::operator== ( const MemoryLocation & Other ) const

inline

Definition at line 323 of file MemoryLocation.h.

References AATags, llvm::Other, Ptr, and Size.

◆ print()

void llvm::MemoryLocation::print ( raw_ostream & OS ) const

inline

Definition at line 250 of file MemoryLocation.h.

References OS, Ptr, and Size.

Member Data Documentation

◆ AATags

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 248 of file MemoryLocation.h.

Referenced by llvm::objcarc::ObjCARCAAResult::alias(), llvm::SCEVAAResult::alias(), llvm::ScopedNoAliasAAResult::alias(), llvm::TypeBasedAAResult::alias(), collectMemAccessInfo(), getAfter(), getBeforeOrAfter(), getForArgument(), llvm::DenseMapInfo< MemoryLocation >::getHashValue(), llvm::ScopedNoAliasAAResult::getModRefInfo(), llvm::TypeBasedAAResult::getModRefInfo(), llvm::objcarc::ObjCARCAAResult::getModRefInfoMask(), llvm::TypeBasedAAResult::getModRefInfoMask(), operator==(), and underlyingObjectsAlias().

◆ Ptr

const Value* llvm::MemoryLocation::Ptr

The address of the start of the location.

Definition at line 235 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(), collectMemAccessInfo(), 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().

◆ Size

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 244 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().

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

include/llvm/Analysis/MemoryLocation.h
lib/Analysis/MemoryLocation.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ MemoryLocation() [1/2]

◆ MemoryLocation() [2/2]

Member Function Documentation

◆ get() [1/6]

◆ get() [2/6]

◆ get() [3/6]

◆ get() [4/6]

◆ get() [5/6]

◆ get() [6/6]

◆ getAfter()

◆ getBeforeOrAfter()

◆ getForArgument() [1/2]

◆ getForArgument() [2/2]

◆ getForDest() [1/4]

◆ getForDest() [2/4]

◆ getForDest() [3/4]

◆ getForDest() [4/4]

◆ getForSource() [1/3]

◆ getForSource() [2/3]

◆ getForSource() [3/3]

◆ getOrNone()

◆ getWithNewPtr()

◆ getWithNewSize()

◆ getWithoutAATags()

◆ operator==()

◆ print()

Member Data Documentation

◆ AATags

◆ Ptr

◆ Size