LLVM 17.0.0git
Public Types | Public Member Functions | Friends | List of all members
llvm::AliasSetTracker Class Reference

#include "llvm/Analysis/AliasSetTracker.h"

Public Types

using iterator = ilist< AliasSet >::iterator
 
using const_iterator = ilist< AliasSet >::const_iterator
 

Public Member Functions

 AliasSetTracker (BatchAAResults &AA)
 Create an empty collection of AliasSets, and use the specified alias analysis object to disambiguate load and store addresses.
 
 ~AliasSetTracker ()
 
void add (Value *Ptr, LocationSize Size, const AAMDNodes &AAInfo)
 These methods are used to add different types of instructions to the alias sets.
 
void add (LoadInst *LI)
 
void add (StoreInst *SI)
 
void add (VAArgInst *VAAI)
 
void add (AnyMemSetInst *MSI)
 
void add (AnyMemTransferInst *MTI)
 
void add (Instruction *I)
 
void add (BasicBlock &BB)
 
void add (const AliasSetTracker &AST)
 
void addUnknown (Instruction *I)
 
void clear ()
 
const ilist< AliasSet > & getAliasSets () const
 Return the alias sets that are active.
 
AliasSetgetAliasSetFor (const MemoryLocation &MemLoc)
 Return the alias set which contains the specified memory location.
 
BatchAAResultsgetAliasAnalysis () const
 Return the underlying alias analysis object used by this tracker.
 
const_iterator begin () const
 
const_iterator end () const
 
iterator begin ()
 
iterator end ()
 
void print (raw_ostream &OS) const
 
void dump () const
 

Friends

class AliasSet
 

Detailed Description

Definition at line 306 of file AliasSetTracker.h.

Member Typedef Documentation

◆ const_iterator

Definition at line 359 of file AliasSetTracker.h.

◆ iterator

Definition at line 358 of file AliasSetTracker.h.

Constructor & Destructor Documentation

◆ AliasSetTracker()

llvm::AliasSetTracker::AliasSetTracker ( BatchAAResults AA)
inlineexplicit

Create an empty collection of AliasSets, and use the specified alias analysis object to disambiguate load and store addresses.

Definition at line 318 of file AliasSetTracker.h.

◆ ~AliasSetTracker()

llvm::AliasSetTracker::~AliasSetTracker ( )
inline

Definition at line 319 of file AliasSetTracker.h.

References clear().

Member Function Documentation

◆ add() [1/9]

void AliasSetTracker::add ( AnyMemSetInst MSI)

Definition at line 390 of file AliasSetTracker.cpp.

References llvm::MemoryLocation::getForDest().

◆ add() [2/9]

void AliasSetTracker::add ( AnyMemTransferInst MTI)

◆ add() [3/9]

void AliasSetTracker::add ( BasicBlock BB)

Definition at line 483 of file AliasSetTracker.cpp.

References add(), and I.

◆ add() [4/9]

void AliasSetTracker::add ( const AliasSetTracker AST)

Definition at line 488 of file AliasSetTracker.cpp.

References add(), assert(), llvm::AliasSet::begin(), E, and llvm::AliasSet::end().

◆ add() [5/9]

void AliasSetTracker::add ( Instruction I)

◆ add() [6/9]

void AliasSetTracker::add ( LoadInst LI)

◆ add() [7/9]

void AliasSetTracker::add ( StoreInst SI)

◆ add() [8/9]

void AliasSetTracker::add ( VAArgInst VAAI)

Definition at line 386 of file AliasSetTracker.cpp.

References llvm::MemoryLocation::get().

◆ add() [9/9]

void AliasSetTracker::add ( Value Ptr,
LocationSize  Size,
const AAMDNodes AAInfo 
)

These methods are used to add different types of instructions to the alias sets.

Adding a new instruction can result in one of three actions happening:

  1. If the instruction doesn't alias any other sets, create a new set.
  2. If the instruction aliases exactly one set, add it to the set
  3. If the instruction aliases multiple sets, merge the sets, and add the instruction to the result.

These methods return true if inserting the instruction resulted in the addition of a new alias set (i.e., the pointer did not alias anything).

Definition at line 369 of file AliasSetTracker.cpp.

References Ptr, and Size.

Referenced by add(), collectPromotionCandidates(), and llvm::AliasSetsPrinterPass::run().

◆ addUnknown()

void AliasSetTracker::addUnknown ( Instruction I)

Definition at line 399 of file AliasSetTracker.cpp.

References AliasSet, and llvm::Instruction::mayReadOrWriteMemory().

Referenced by add().

◆ begin() [1/2]

iterator llvm::AliasSetTracker::begin ( )
inline

Definition at line 364 of file AliasSetTracker.h.

◆ begin() [2/2]

const_iterator llvm::AliasSetTracker::begin ( ) const
inline

Definition at line 361 of file AliasSetTracker.h.

◆ clear()

void AliasSetTracker::clear ( )

Definition at line 258 of file AliasSetTracker.cpp.

References I.

Referenced by ~AliasSetTracker().

◆ dump()

LLVM_DUMP_METHOD void AliasSetTracker::dump ( ) const

Definition at line 618 of file AliasSetTracker.cpp.

References llvm::dbgs(), and print().

◆ end() [1/2]

iterator llvm::AliasSetTracker::end ( )
inline

Definition at line 365 of file AliasSetTracker.h.

◆ end() [2/2]

const_iterator llvm::AliasSetTracker::end ( ) const
inline

Definition at line 362 of file AliasSetTracker.h.

◆ getAliasAnalysis()

BatchAAResults & llvm::AliasSetTracker::getAliasAnalysis ( ) const
inline

Return the underlying alias analysis object used by this tracker.

Definition at line 356 of file AliasSetTracker.h.

◆ getAliasSetFor()

AliasSet & AliasSetTracker::getAliasSetFor ( const MemoryLocation MemLoc)

Return the alias set which contains the specified memory location.

If the memory location aliases two or more existing alias sets, will have the effect of merging those alias sets before the single resulting alias set is returned.

Definition at line 318 of file AliasSetTracker.cpp.

References llvm::MemoryLocation::AATags, AliasSet, assert(), llvm::MemoryLocation::Ptr, llvm::MemoryLocation::Size, and Size.

◆ getAliasSets()

const ilist< AliasSet > & llvm::AliasSetTracker::getAliasSets ( ) const
inline

Return the alias sets that are active.

Definition at line 347 of file AliasSetTracker.h.

◆ print()

void AliasSetTracker::print ( raw_ostream OS) const

Friends And Related Function Documentation

◆ AliasSet

friend class AliasSet
friend

Definition at line 371 of file AliasSetTracker.h.

Referenced by addUnknown(), and getAliasSetFor().


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