LLVM  6.0.0svn
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
llvm::MemoryUseOrDef Class Reference

Class that has the common methods + fields of memory uses/defs. More...

#include "llvm/Analysis/MemorySSA.h"

Inheritance diagram for llvm::MemoryUseOrDef:
Inheritance graph
[legend]
Collaboration diagram for llvm::MemoryUseOrDef:
Collaboration graph
[legend]

Public Member Functions

void * operator new (size_t)=delete
 
 DECLARE_TRANSPARENT_OPERAND_ACCESSORS (MemoryAccess)
 
InstructiongetMemoryInst () const
 Get the instruction that this MemoryUse represents. More...
 
MemoryAccessgetDefiningAccess () const
 Get the access that produces the memory state used by this Use. More...
 
bool isOptimized () const
 
MemoryAccessgetOptimized () const
 
void setOptimized (MemoryAccess *)
 
void resetOptimized ()
 Reset the ID of what this MemoryUse was optimized to, causing it to be rewalked by the walker if necessary. More...
 
- Public Member Functions inherited from llvm::MemoryAccess
 MemoryAccess (const MemoryAccess &)=delete
 
MemoryAccessoperator= (const MemoryAccess &)=delete
 
void * operator new (size_t)=delete
 
BasicBlockgetBlock () const
 
void print (raw_ostream &OS) const
 
void dump () const
 
memoryaccess_def_iterator defs_begin ()
 This iterator walks over all of the defs in a given MemoryAccess. More...
 
const_memoryaccess_def_iterator defs_begin () const
 
memoryaccess_def_iterator defs_end ()
 
const_memoryaccess_def_iterator defs_end () const
 
AllAccessType::self_iterator getIterator ()
 Get the iterators for the all access list and the defs only list We default to the all access list. More...
 
AllAccessType::const_self_iterator getIterator () const
 
AllAccessType::reverse_self_iterator getReverseIterator ()
 
AllAccessType::const_reverse_self_iterator getReverseIterator () const
 
DefsOnlyType::self_iterator getDefsIterator ()
 
DefsOnlyType::const_self_iterator getDefsIterator () const
 
DefsOnlyType::reverse_self_iterator getReverseDefsIterator ()
 
DefsOnlyType::const_reverse_self_iterator getReverseDefsIterator () const
 
- Public Member Functions inherited from llvm::DerivedUser
 DerivedUser (Type *Ty, unsigned VK, Use *U, unsigned NumOps, DeleteValueTy DeleteValue)
 
- Public Member Functions inherited from llvm::User
 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *, unsigned)
 Placement delete - required by std, but never called. More...
 
void operator delete (void *, unsigned, bool)
 Placement delete - required by std, but never called. More...
 
const UsegetOperandList () const
 
UsegetOperandList ()
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
ArrayRef< const uint8_t > getDescriptor () const
 Returns the descriptor co-allocated with this User instance. More...
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance. More...
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
const_value_op_iterator value_op_begin () const
 
const_value_op_iterator value_op_end () const
 
iterator_range< const_value_op_iteratoroperand_values () const
 
void dropAllReferences ()
 Drop all references to operands. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value. More...
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
void replaceUsesExceptBlockAddr (Value *New)
 replaceUsesExceptBlockAddr - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
use_iterator materialized_use_begin ()
 
const_use_iterator materialized_use_begin () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
bool user_empty () const
 
user_iterator materialized_user_begin ()
 
const_user_iterator materialized_user_begin () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one user of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N users. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N users or more. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndBarriers () const
 Strip off pointer casts, all-zero GEPs, aliases and barriers. More...
 
ValuestripPointerCastsAndBarriers ()
 
const ValuestripPointerCastsNoFollowAliases () const
 Strip off pointer casts and all-zero GEPs. More...
 
ValuestripPointerCastsNoFollowAliases ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets () const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets ()
 
unsigned getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
 
unsigned getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 
- Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< MemoryAccess, Options... >::type >
self_iterator getIterator ()
 
const_self_iterator getIterator () const
 
reverse_self_iterator getReverseIterator ()
 
const_reverse_self_iterator getReverseIterator () const
 
bool isSentinel () const
 Check whether this is the sentinel node. More...
 

Static Public Member Functions

static bool classof (const Value *MA)
 
- Static Public Member Functions inherited from llvm::MemoryAccess
static bool classof (const Value *V)
 
- Static Public Member Functions inherited from llvm::User
static bool classof (const Value *V)
 

Protected Member Functions

 MemoryUseOrDef (LLVMContext &C, MemoryAccess *DMA, unsigned Vty, DeleteValueTy DeleteValue, Instruction *MI, BasicBlock *BB)
 
void setDefiningAccess (MemoryAccess *DMA, bool Optimized=false)
 
- Protected Member Functions inherited from llvm::MemoryAccess
void setBlock (BasicBlock *BB)
 Used by MemorySSA to change the block of a MemoryAccess when it is moved. More...
 
unsigned getID () const
 Used for debugging and tracking things about MemoryAccesses. More...
 
 MemoryAccess (LLVMContext &C, unsigned Vty, DeleteValueTy DeleteValue, BasicBlock *BB, unsigned NumOperands)
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated. More...
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated. More...
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
 ~User ()=default
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
- Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< MemoryAccess, Options... >::type >
 ilist_node_impl ()=default
 

Friends

class MemorySSA
 
class MemorySSAUpdater
 

Additional Inherited Members

- Public Types inherited from llvm::MemoryAccess
using AllAccessType = ilist_node< MemoryAccess, ilist_tag< MSSAHelpers::AllAccessTag > >
 
using DefsOnlyType = ilist_node< MemoryAccess, ilist_tag< MSSAHelpers::DefsOnlyTag > >
 
using iterator = user_iterator
 The user iterators for a memory access. More...
 
using const_iterator = const_user_iterator
 
- Public Types inherited from llvm::User
using op_iterator = Use *
 
using const_op_iterator = const Use *
 
using op_range = iterator_range< op_iterator >
 
using const_op_range = iterator_range< const_op_iterator >
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
using use_iterator = use_iterator_impl< Use >
 
using const_use_iterator = use_iterator_impl< const Use >
 
using user_iterator = user_iterator_impl< User >
 
using const_user_iterator = user_iterator_impl< const User >
 
- Static Public Attributes inherited from llvm::Value
static const unsigned MaxAlignmentExponent = 29
 The maximum alignment for instructions. More...
 
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent
 
- Protected Types inherited from llvm::DerivedUser
using DeleteValueTy = void(*)(DerivedUser *)
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 28 }
 The number of operands in the subclass. More...
 
- Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< MemoryAccess, Options... >::type >
using self_iterator = ilist_iterator< ilist_detail::compute_node_options< MemoryAccess, Options... >::type, false, false >
 
using const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< MemoryAccess, Options... >::type, false, true >
 
using reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< MemoryAccess, Options... >::type, true, false >
 
using const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< MemoryAccess, Options... >::type, true, true >
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Detailed Description

Class that has the common methods + fields of memory uses/defs.

It's a little awkward to have, but there are many cases where we want either a use or def, and there are many cases where uses are needed (defs aren't acceptable), and vice-versa.

This class should never be instantiated directly; make a MemoryUse or MemoryDef instead.

Definition at line 236 of file MemorySSA.h.

Constructor & Destructor Documentation

◆ MemoryUseOrDef()

llvm::MemoryUseOrDef::MemoryUseOrDef ( LLVMContext C,
MemoryAccess DMA,
unsigned  Vty,
DeleteValueTy  DeleteValue,
Instruction MI,
BasicBlock BB 
)
inlineprotected

Definition at line 267 of file MemorySSA.h.

Member Function Documentation

◆ classof()

static bool llvm::MemoryUseOrDef::classof ( const Value MA)
inlinestatic

Definition at line 248 of file MemorySSA.h.

References llvm::Value::getValueID().

◆ DECLARE_TRANSPARENT_OPERAND_ACCESSORS()

llvm::MemoryUseOrDef::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( MemoryAccess  )

◆ getDefiningAccess()

MemoryAccess* llvm::MemoryUseOrDef::getDefiningAccess ( ) const
inline

Get the access that produces the memory state used by this Use.

Definition at line 246 of file MemorySSA.h.

Referenced by llvm::MemorySSAUpdater::insertDef(), and llvm::GVNHoist::rank().

◆ getMemoryInst()

Instruction* llvm::MemoryUseOrDef::getMemoryInst ( ) const
inline

◆ getOptimized()

MemoryAccess * llvm::MemoryUseOrDef::getOptimized ( ) const
inline

Definition at line 587 of file MemorySSA.h.

◆ isOptimized()

bool llvm::MemoryUseOrDef::isOptimized ( ) const
inline

Definition at line 581 of file MemorySSA.h.

◆ operator new()

void* llvm::MemoryUseOrDef::operator new ( size_t  )
delete

◆ resetOptimized()

void llvm::MemoryUseOrDef::resetOptimized ( )
inline

Reset the ID of what this MemoryUse was optimized to, causing it to be rewalked by the walker if necessary.

This really should only be called by tests.

Definition at line 600 of file MemorySSA.h.

◆ setDefiningAccess()

void llvm::MemoryUseOrDef::setDefiningAccess ( MemoryAccess DMA,
bool  Optimized = false 
)
inlineprotected

◆ setOptimized()

void llvm::MemoryUseOrDef::setOptimized ( MemoryAccess MA)
inline

Definition at line 593 of file MemorySSA.h.

Friends And Related Function Documentation

◆ MemorySSA

friend class MemorySSA
friend

Definition at line 264 of file MemorySSA.h.

◆ MemorySSAUpdater

friend class MemorySSAUpdater
friend

Definition at line 265 of file MemorySSA.h.


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