LLVM  7.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
llvm::MemoryLocation Class Reference

Representation for a specific memory location. More...

#include "llvm/Analysis/MemoryLocation.h"

Collaboration diagram for llvm::MemoryLocation:
Collaboration graph

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

 MemoryLocation (const Value *Ptr=nullptr, uint64_t Size=UnknownSize, const AAMDNodes &AATags=AAMDNodes())
MemoryLocation getWithNewPtr (const Value *NewPtr) const
MemoryLocation getWithNewSize (uint64_t 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. More...
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 Optional< MemoryLocationgetOrNone (const Instruction *Inst)
static MemoryLocation getForSource (const MemTransferInst *MTI)
 Return a location representing the source of a memory transfer. More...
static MemoryLocation getForDest (const MemIntrinsic *MI)
 Return a location representing the destination of a memory set or transfer. More...
static MemoryLocation getForArgument (ImmutableCallSite CS, unsigned ArgIdx, const TargetLibraryInfo &TLI)
 Return a location representing a particular argument of a call. More...

Public Attributes

const ValuePtr
 The address of the start of the location. More...
uint64_t Size
 The maximum size of the location, in address-units, or UnknownSize if the size is not known. More...
AAMDNodes AATags
 The metadata nodes which describes the aliasing of the location (each member is null if that kind of information is unavailable). More...

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


Definition at line 46 of file MemoryLocation.h.

Constructor & Destructor Documentation

◆ MemoryLocation()

llvm::MemoryLocation::MemoryLocation ( const Value Ptr = nullptr,
uint64_t  Size = UnknownSize,
const AAMDNodes AATags = AAMDNodes() 

Member Function Documentation

◆ get() [1/6]

MemoryLocation MemoryLocation::get ( const LoadInst LI)

◆ get() [2/6]

MemoryLocation MemoryLocation::get ( const StoreInst SI)

◆ get() [3/6]

MemoryLocation MemoryLocation::get ( const VAArgInst VI)

◆ get() [4/6]

MemoryLocation MemoryLocation::get ( const AtomicCmpXchgInst CXI)

◆ get() [5/6]

MemoryLocation MemoryLocation::get ( const AtomicRMWInst RMWI)

◆ get() [6/6]

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

Definition at line 71 of file MemoryLocation.h.

References getOrNone().

◆ getForArgument()

MemoryLocation MemoryLocation::getForArgument ( ImmutableCallSite  CS,
unsigned  ArgIdx,
const TargetLibraryInfo TLI 

◆ getForDest()

MemoryLocation MemoryLocation::getForDest ( const MemIntrinsic MI)

◆ getForSource()

MemoryLocation MemoryLocation::getForSource ( const MemTransferInst MTI)

◆ getOrNone()

static Optional<MemoryLocation> llvm::MemoryLocation::getOrNone ( const Instruction Inst)

◆ getWithNewPtr()

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

Definition at line 107 of file MemoryLocation.h.

References Ptr.

Referenced by SortNonLocalDepInfoCache().

◆ getWithNewSize()

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

Definition at line 113 of file MemoryLocation.h.

References Size.

Referenced by SortNonLocalDepInfoCache().

◆ getWithoutAATags()

MemoryLocation llvm::MemoryLocation::getWithoutAATags ( ) const

Definition at line 119 of file MemoryLocation.h.

References AATags.

Referenced by SortNonLocalDepInfoCache().

◆ operator==()

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

Definition at line 125 of file MemoryLocation.h.

References AATags, Ptr, and Size.

Member Data Documentation

◆ AATags

AAMDNodes llvm::MemoryLocation::AATags

◆ Ptr

const Value* llvm::MemoryLocation::Ptr

◆ Size

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

Referenced by llvm::SCEVAAResult::alias(), llvm::objcarc::ObjCARCAAResult::alias(), llvm::BasicAAResult::alias(), eliminateDeadStores(), getForDest(), getForSource(), llvm::DenseMapInfo< MemoryLocation >::getHashValue(), getWithNewSize(), isOverwrite(), operator==(), llvm::objcarc::ObjCARCAAResult::pointsToConstantMemory(), llvm::CFLAndersAAResult::query(), removePartiallyOverlappedStores(), and SortNonLocalDepInfoCache().

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