LLVM  3.7.0
Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::PreservedAnalyses Class Reference

An abstract set of preserved analyses following a transformation pass run. More...

#include <PassManager.h>

Public Member Functions

 PreservedAnalyses ()
 
 PreservedAnalyses (const PreservedAnalyses &Arg)
 
 PreservedAnalyses (PreservedAnalyses &&Arg)
 
PreservedAnalysesoperator= (PreservedAnalyses RHS)
 
template<typename PassT >
void preserve ()
 Mark a particular pass as preserved, adding it to the set. More...
 
void preserve (void *PassID)
 Mark an abstract PassID as preserved, adding it to the set. More...
 
void intersect (const PreservedAnalyses &Arg)
 Intersect this set with another in place. More...
 
void intersect (PreservedAnalyses &&Arg)
 Intersect this set with a temporary other set in place. More...
 
template<typename PassT >
bool preserved () const
 Query whether a pass is marked as preserved by this set. More...
 
bool preserved (void *PassID) const
 Query whether an abstract pass ID is marked as preserved by this set. More...
 
bool areAllPreserved () const
 Test whether all passes are preserved. More...
 

Static Public Member Functions

static PreservedAnalyses none ()
 Convenience factory function for the empty preserved set. More...
 
static PreservedAnalyses all ()
 Construct a special preserved set that preserves all passes. More...
 

Friends

void swap (PreservedAnalyses &LHS, PreservedAnalyses &RHS)
 

Detailed Description

An abstract set of preserved analyses following a transformation pass run.

When a transformation pass is run, it can return a set of analyses whose results were preserved by that transformation. The default set is "none", and preserving analyses must be done explicitly.

There is also an explicit all state which can be used (for example) when the IR is not mutated at all.

Definition at line 69 of file PassManager.h.

Constructor & Destructor Documentation

llvm::PreservedAnalyses::PreservedAnalyses ( )
inline

Definition at line 73 of file PassManager.h.

Referenced by none().

llvm::PreservedAnalyses::PreservedAnalyses ( const PreservedAnalyses Arg)
inline

Definition at line 74 of file PassManager.h.

llvm::PreservedAnalyses::PreservedAnalyses ( PreservedAnalyses &&  Arg)
inline

Definition at line 76 of file PassManager.h.

Member Function Documentation

static PreservedAnalyses llvm::PreservedAnalyses::all ( )
inlinestatic
bool llvm::PreservedAnalyses::areAllPreserved ( ) const
inline

Test whether all passes are preserved.

This is used primarily to optimize for the case of no changes which will common in many scenarios.

Definition at line 154 of file PassManager.h.

References llvm::SmallPtrSetImpl< PtrType >::count().

Referenced by intersect(), and preserve().

void llvm::PreservedAnalyses::intersect ( const PreservedAnalyses Arg)
inline

Intersect this set with another in place.

This is a mutating operation on this preserved set, removing all preserved passes which are not also preserved in the argument.

Definition at line 110 of file PassManager.h.

References areAllPreserved(), llvm::SmallPtrSetImpl< PtrType >::count(), llvm::SmallPtrSetImpl< PtrType >::erase(), and P.

Referenced by llvm::PassManager< IRUnitT >::run(), llvm::CGSCCToFunctionPassAdaptor< FunctionPassT >::run(), and llvm::ModuleToFunctionPassAdaptor< FunctionPassT >::run().

void llvm::PreservedAnalyses::intersect ( PreservedAnalyses &&  Arg)
inline

Intersect this set with a temporary other set in place.

This is a mutating operation on this preserved set, removing all preserved passes which are not also preserved in the argument.

Definition at line 126 of file PassManager.h.

References areAllPreserved(), and P.

static PreservedAnalyses llvm::PreservedAnalyses::none ( )
inlinestatic

Convenience factory function for the empty preserved set.

Definition at line 88 of file PassManager.h.

References PreservedAnalyses().

Referenced by llvm::LowerExpectIntrinsicPass::run(), llvm::SimplifyCFGPass::run(), and llvm::InvalidateAllAnalysesPass::run().

PreservedAnalyses& llvm::PreservedAnalyses::operator= ( PreservedAnalyses  RHS)
inline

Definition at line 82 of file PassManager.h.

References swap.

template<typename PassT >
void llvm::PreservedAnalyses::preserve ( )
inline
void llvm::PreservedAnalyses::preserve ( void *  PassID)
inline

Mark an abstract PassID as preserved, adding it to the set.

Definition at line 101 of file PassManager.h.

References areAllPreserved(), and llvm::SmallPtrSetImpl< PtrType >::insert().

template<typename PassT >
bool llvm::PreservedAnalyses::preserved ( ) const
inline
bool llvm::PreservedAnalyses::preserved ( void *  PassID) const
inline

Query whether an abstract pass ID is marked as preserved by this set.

Definition at line 145 of file PassManager.h.

References llvm::SmallPtrSetImpl< PtrType >::count().

Friends And Related Function Documentation

void swap ( PreservedAnalyses LHS,
PreservedAnalyses RHS 
)
friend

Definition at line 78 of file PassManager.h.

Referenced by operator=().


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