LLVM  15.0.0git
llvm::SCCPSolver Class Reference

SCCPSolver - This interface class is a general purpose solver for Sparse Conditional Constant Propagation (SCCP). More...

#include "llvm/Transforms/Utils/SCCPSolver.h"

## Public Member Functions

SCCPSolver (const DataLayout &DL, std::function< const TargetLibraryInfo &(Function &)> GetTLI, LLVMContext &Ctx)

~SCCPSolver ()

void addAnalysis (Function &F, AnalysisResultsForFn A)

bool markBlockExecutable (BasicBlock *BB)
markBlockExecutable - This method can be used by clients to mark all of the blocks that are known to be intrinsically live in the processed unit. More...

const PredicateBasegetPredicateInfoFor (Instruction *I)

DomTreeUpdater getDTU (Function &F)

void trackValueOfGlobalVariable (GlobalVariable *GV)
trackValueOfGlobalVariable - Clients can use this method to inform the SCCPSolver that it should track loads and stores to the specified global variable if it can. More...

void addTrackedFunction (Function *F)
addTrackedFunction - If the SCCP solver is supposed to track calls into and out of the specified function (which cannot have its address taken), this method must be called. More...

void addToMustPreserveReturnsInFunctions (Function *F)
Add function to the list of functions whose return cannot be modified. More...

bool mustPreserveReturn (Function *F)
Returns true if the return of the given function cannot be modified. More...

void addArgumentTrackedFunction (Function *F)

bool isArgumentTrackedFunction (Function *F)
Returns true if the given function is in the solver's set of argument-tracked functions. More...

void solve ()
Solve - Solve for constants and executable blocks. More...

bool resolvedUndefsIn (Function &F)
resolvedUndefsIn - While solving the dataflow for a function, we assume that branches on undef values cannot reach any of their successors. More...

bool isBlockExecutable (BasicBlock *BB) const

bool isEdgeFeasible (BasicBlock *From, BasicBlock *To) const

std::vector< ValueLatticeElementgetStructLatticeValueFor (Value *V) const

void removeLatticeValueFor (Value *V)

const ValueLatticeElementgetLatticeValueFor (Value *V) const

const MapVector< Function *, ValueLatticeElement > & getTrackedRetVals ()
getTrackedRetVals - Get the inferred return value map. More...

const DenseMap< GlobalVariable *, ValueLatticeElement > & getTrackedGlobals ()
getTrackedGlobals - Get and return the set of inferred initializers for global variables. More...

const SmallPtrSet< Function *, 16 > getMRVFunctionsTracked ()
getMRVFunctionsTracked - Get the set of functions which return multiple values tracked by the pass. More...

void markOverdefined (Value *V)
markOverdefined - Mark the specified value overdefined. More...

bool isStructLatticeConstant (Function *F, StructType *STy)

ConstantgetConstant (const ValueLatticeElement &LV) const
Helper to return a Constant if LV is either a constant or a constant range with a single element. More...

SmallPtrSetImpl< Function * > & getArgumentTrackedFunctions ()
Return a reference to the set of argument tracked functions. More...

void markArgInFuncSpecialization (Function *F, const SmallVectorImpl< ArgInfo > &Args)
Mark the constant arguments of a new function specialization. More...

void markFunctionUnreachable (Function *F)
Mark all of the blocks in function F non-executable. More...

void visit (Instruction *I)

void visitCall (CallInst &I)

## Detailed Description

SCCPSolver - This interface class is a general purpose solver for Sparse Conditional Constant Propagation (SCCP).

Definition at line 61 of file SCCPSolver.h.

## ◆ SCCPSolver()

 SCCPSolver::SCCPSolver ( const DataLayout & DL, std::function< const TargetLibraryInfo &(Function &)> GetTLI, LLVMContext & Ctx )

Definition at line 1529 of file SCCPSolver.cpp.

## ◆ ~SCCPSolver()

 SCCPSolver::~SCCPSolver ( )
default

## Member Function Documentation

 void SCCPSolver::addAnalysis ( Function & F, AnalysisResultsForFn A )

Definition at line 1537 of file SCCPSolver.cpp.

References A, F, and move.

Referenced by llvm::runFunctionSpecialization(), and llvm::runIPSCCP().

 void SCCPSolver::addArgumentTrackedFunction ( Function * F )

Definition at line 1567 of file SCCPSolver.cpp.

References F.

Referenced by llvm::runFunctionSpecialization(), and llvm::runIPSCCP().

 void SCCPSolver::addToMustPreserveReturnsInFunctions ( Function * F )

Add function to the list of functions whose return cannot be modified.

Definition at line 1559 of file SCCPSolver.cpp.

References F.

Referenced by tryToReplaceWithConstant().

 void SCCPSolver::addTrackedFunction ( Function * F )

addTrackedFunction - If the SCCP solver is supposed to track calls into and out of the specified function (which cannot have its address taken), this method must be called.

Definition at line 1555 of file SCCPSolver.cpp.

References F.

Referenced by llvm::runIPSCCP().

## ◆ getArgumentTrackedFunctions()

 SmallPtrSetImpl< Function * > & SCCPSolver::getArgumentTrackedFunctions ( )

Return a reference to the set of argument tracked functions.

Definition at line 1626 of file SCCPSolver.cpp.

Referenced by llvm::runFunctionSpecialization().

## ◆ getConstant()

 Constant * SCCPSolver::getConstant ( const ValueLatticeElement & LV ) const

Helper to return a Constant if LV is either a constant or a constant range with a single element.

Definition at line 1622 of file SCCPSolver.cpp.

Referenced by tryToReplaceWithConstant().

## ◆ getDTU()

 DomTreeUpdater SCCPSolver::getDTU ( Function & F )

Definition at line 1549 of file SCCPSolver.cpp.

References F.

Referenced by llvm::runIPSCCP().

## ◆ getLatticeValueFor()

 const ValueLatticeElement & SCCPSolver::getLatticeValueFor ( Value * V ) const

## ◆ getMRVFunctionsTracked()

 const SmallPtrSet< Function *, 16 > SCCPSolver::getMRVFunctionsTracked ( )

getMRVFunctionsTracked - Get the set of functions which return multiple values tracked by the pass.

Definition at line 1612 of file SCCPSolver.cpp.

Referenced by llvm::runIPSCCP().

## ◆ getPredicateInfoFor()

 const PredicateBase * SCCPSolver::getPredicateInfoFor ( Instruction * I )

Definition at line 1545 of file SCCPSolver.cpp.

References I.

Referenced by llvm::runIPSCCP().

## ◆ getStructLatticeValueFor()

 std::vector< ValueLatticeElement > SCCPSolver::getStructLatticeValueFor ( Value * V ) const

Definition at line 1590 of file SCCPSolver.cpp.

Referenced by tryToReplaceWithConstant().

## ◆ getTrackedGlobals()

 const DenseMap< GlobalVariable *, ValueLatticeElement > & SCCPSolver::getTrackedGlobals ( )

getTrackedGlobals - Get and return the set of inferred initializers for global variables.

Definition at line 1608 of file SCCPSolver.cpp.

Referenced by llvm::runIPSCCP().

## ◆ getTrackedRetVals()

 const MapVector< Function *, ValueLatticeElement > & SCCPSolver::getTrackedRetVals ( )

getTrackedRetVals - Get the inferred return value map.

Definition at line 1603 of file SCCPSolver.cpp.

Referenced by llvm::runIPSCCP().

## ◆ isArgumentTrackedFunction()

 bool SCCPSolver::isArgumentTrackedFunction ( Function * F )

Returns true if the given function is in the solver's set of argument-tracked functions.

Definition at line 1571 of file SCCPSolver.cpp.

References F.

Referenced by findReturnsToZap().

## ◆ isBlockExecutable()

 bool SCCPSolver::isBlockExecutable ( BasicBlock * BB ) const

Definition at line 1581 of file SCCPSolver.cpp.

References BB.

Referenced by llvm::runFunctionSpecialization(), llvm::runIPSCCP(), and runSCCP().

## ◆ isEdgeFeasible()

 bool SCCPSolver::isEdgeFeasible ( BasicBlock * From, BasicBlock * To ) const

Definition at line 1585 of file SCCPSolver.cpp.

References From.

Referenced by removeNonFeasibleEdges().

## ◆ isStructLatticeConstant()

 bool SCCPSolver::isStructLatticeConstant ( Function * F, StructType * STy )

Definition at line 1618 of file SCCPSolver.cpp.

References F.

Referenced by llvm::runIPSCCP().

## ◆ markArgInFuncSpecialization()

 void SCCPSolver::markArgInFuncSpecialization ( Function * F, const SmallVectorImpl< ArgInfo > & Args )

Mark the constant arguments of a new function specialization.

F points to the cloned function and Args contains a list of constant arguments represented as pairs of {formal,actual} values (the formal argument is associated with the original function definition). All other arguments of the specialization inherit the lattice state of their corresponding values in the original function.

Definition at line 1630 of file SCCPSolver.cpp.

References llvm::AMDGPU::HSAMD::Kernel::Key::Args, and F.

## ◆ markBlockExecutable()

 bool SCCPSolver::markBlockExecutable ( BasicBlock * BB )

markBlockExecutable - This method can be used by clients to mark all of the blocks that are known to be intrinsically live in the processed unit.

This returns true if the block was not considered live before.

Definition at line 1541 of file SCCPSolver.cpp.

References BB.

Referenced by llvm::runFunctionSpecialization(), llvm::runIPSCCP(), and runSCCP().

## ◆ markFunctionUnreachable()

 void SCCPSolver::markFunctionUnreachable ( Function * F )

Mark all of the blocks in function F non-executable.

Clients can used this method to erase a function from the module (e.g., if it has been completely specialized and is no longer needed).

Definition at line 1635 of file SCCPSolver.cpp.

References F.

## ◆ markOverdefined()

 void SCCPSolver::markOverdefined ( Value * V )

markOverdefined - Mark the specified value overdefined.

This works with both scalars and structs.

Definition at line 1616 of file SCCPSolver.cpp.

Referenced by llvm::runFunctionSpecialization(), llvm::runIPSCCP(), and runSCCP().

## ◆ mustPreserveReturn()

 bool SCCPSolver::mustPreserveReturn ( Function * F )

Returns true if the return of the given function cannot be modified.

Definition at line 1563 of file SCCPSolver.cpp.

References F.

Referenced by findReturnsToZap().

## ◆ removeLatticeValueFor()

 void SCCPSolver::removeLatticeValueFor ( Value * V )

Definition at line 1594 of file SCCPSolver.cpp.

Referenced by simplifyInstsInBlock().

## ◆ resolvedUndefsIn()

 bool SCCPSolver::resolvedUndefsIn ( Function & F )

resolvedUndefsIn - While solving the dataflow for a function, we assume that branches on undef values cannot reach any of their successors.

However, this is not a safe assumption. After we solve dataflow, this method should be use to handle this. If this returns true, the solver should be rerun.

Definition at line 1577 of file SCCPSolver.cpp.

References F.

Referenced by llvm::runFunctionSpecialization(), llvm::runIPSCCP(), and runSCCP().

## ◆ solve()

 void SCCPSolver::solve ( )

Solve - Solve for constants and executable blocks.

Definition at line 1575 of file SCCPSolver.cpp.

Referenced by llvm::runFunctionSpecialization(), llvm::runIPSCCP(), and runSCCP().

## ◆ trackValueOfGlobalVariable()

 void SCCPSolver::trackValueOfGlobalVariable ( GlobalVariable * GV )

trackValueOfGlobalVariable - Clients can use this method to inform the SCCPSolver that it should track loads and stores to the specified global variable if it can.

This is only legal to call if performing Interprocedural SCCP.

Definition at line 1551 of file SCCPSolver.cpp.

Referenced by llvm::runFunctionSpecialization(), and llvm::runIPSCCP().

## ◆ visit()

 void SCCPSolver::visit ( Instruction * I )

Definition at line 1639 of file SCCPSolver.cpp.

References I.

## ◆ visitCall()

 void SCCPSolver::visitCall ( CallInst & I )

Definition at line 1641 of file SCCPSolver.cpp.

References I.

Referenced by constantArgPropagation().

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