LLVM 20.0.0git
Public Member Functions | Static Public Member Functions | List of all members
llvm::BranchProbability Class Reference

#include "llvm/Support/BranchProbability.h"

Public Member Functions

 BranchProbability ()
 
 BranchProbability (uint32_t Numerator, uint32_t Denominator)
 
bool isZero () const
 
bool isUnknown () const
 
uint32_t getNumerator () const
 
BranchProbability getCompl () const
 
raw_ostream & print (raw_ostream &OS) const
 
void dump () const
 
uint64_t scale (uint64_t Num) const
 Scale a large integer.
 
uint64_t scaleByInverse (uint64_t Num) const
 Scale a large integer by the inverse.
 
BranchProbability & operator+= (BranchProbability RHS)
 
BranchProbability & operator-= (BranchProbability RHS)
 
BranchProbability & operator*= (BranchProbability RHS)
 
BranchProbability & operator*= (uint32_t RHS)
 
BranchProbability & operator/= (BranchProbability RHS)
 
BranchProbability & operator/= (uint32_t RHS)
 
BranchProbability operator+ (BranchProbability RHS) const
 
BranchProbability operator- (BranchProbability RHS) const
 
BranchProbability operator* (BranchProbability RHS) const
 
BranchProbability operator* (uint32_t RHS) const
 
BranchProbability operator/ (BranchProbability RHS) const
 
BranchProbability operator/ (uint32_t RHS) const
 
bool operator== (BranchProbability RHS) const
 
bool operator!= (BranchProbability RHS) const
 
bool operator< (BranchProbability RHS) const
 
bool operator> (BranchProbability RHS) const
 
bool operator<= (BranchProbability RHS) const
 
bool operator>= (BranchProbability RHS) const
 

Static Public Member Functions

static BranchProbability getZero ()
 
static BranchProbability getOne ()
 
static BranchProbability getUnknown ()
 
static BranchProbability getRaw (uint32_t N)
 
static BranchProbability getBranchProbability (uint64_t Numerator, uint64_t Denominator)
 
template<class ProbabilityIter >
static void normalizeProbabilities (ProbabilityIter Begin, ProbabilityIter End)
 
static uint32_t getDenominator ()
 

Detailed Description

Definition at line 30 of file BranchProbability.h.

Constructor & Destructor Documentation

◆ BranchProbability() [1/2]

llvm::BranchProbability::BranchProbability ( )
inline

Definition at line 43 of file BranchProbability.h.

References N.

Referenced by getBranchProbability(), getCompl(), getOne(), getRaw(), getUnknown(), and getZero().

◆ BranchProbability() [2/2]

BranchProbability::BranchProbability ( uint32_t  Numerator,
uint32_t  Denominator 
)

Definition at line 40 of file BranchProbability.cpp.

References assert().

Member Function Documentation

◆ dump()

LLVM_DUMP_METHOD void BranchProbability::dump ( ) const

Definition at line 37 of file BranchProbability.cpp.

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

◆ getBranchProbability()

BranchProbability BranchProbability::getBranchProbability ( uint64_t  Numerator,
uint64_t  Denominator 
)
static

Definition at line 53 of file BranchProbability.cpp.

References assert(), and BranchProbability().

Referenced by extractBranchProbabilities(), foldTwoEntryPHINode(), getCHRBiasThreshold(), llvm::BFIDOTGraphTraitsBase< BlockFrequencyInfoT, BranchProbabilityInfoT >::getNodeAttributes(), isFormingBranchFromSelectProfitable(), isProfitableToSpeculate(), shouldFoldCondBranchesToCommonDestination(), SimplifyCondBranchToCondBranch(), llvm::JumpThreadingPass::unfoldSelectInstr(), updatePredecessorProfileMetadata(), and llvm::misexpect::verifyMisExpect().

◆ getCompl()

BranchProbability llvm::BranchProbability::getCompl ( ) const
inline

Definition at line 69 of file BranchProbability.h.

References BranchProbability(), and N.

Referenced by foldTwoEntryPHINode(), llvm::BranchProbabilityInfo::getBranchProbStackProtector(), llvm::ARMBaseInstrInfo::isProfitableToIfCvt(), scaleCaseProbality(), shouldFoldCondBranchesToCommonDestination(), splitMBB(), and updatePredecessorProfileMetadata().

◆ getDenominator()

static uint32_t llvm::BranchProbability::getDenominator ( )
inlinestatic

Definition at line 66 of file BranchProbability.h.

Referenced by llvm::BFIDOTGraphTraitsBase< BlockFrequencyInfoT, BranchProbabilityInfoT >::getEdgeAttributes(), normalizeProbabilities(), llvm::MachineBasicBlock::print(), scaleCaseProbality(), llvm::BranchProbabilityInfo::setEdgeProbability(), and llvm::MachineBasicBlock::validateSuccProbs().

◆ getNumerator()

uint32_t llvm::BranchProbability::getNumerator ( ) const
inline

Definition at line 65 of file BranchProbability.h.

References N.

Referenced by llvm::AsmPrinter::emitBBAddrMapSection(), getAdjustedProbability(), llvm::BFIDOTGraphTraitsBase< BlockFrequencyInfoT, BranchProbabilityInfoT >::getEdgeAttributes(), llvm::getWeightFromBranchProb(), llvm::MIPrinter::print(), llvm::MachineBasicBlock::print(), scaleCaseProbality(), and updatePredecessorProfileMetadata().

◆ getOne()

static BranchProbability llvm::BranchProbability::getOne ( )
inlinestatic

Definition at line 50 of file BranchProbability.h.

References BranchProbability().

Referenced by llvm::X86FrameLowering::adjustForSegmentedStacks(), llvm::PPCTargetLowering::emitEHSjLjSetJmp(), getAdjustedProbability(), and scaleCaseProbality().

◆ getRaw()

static BranchProbability llvm::BranchProbability::getRaw ( uint32_t  N)
inlinestatic

Definition at line 54 of file BranchProbability.h.

References BranchProbability(), and N.

Referenced by decodeBBAddrMapImpl(), and normalizeProbabilities().

◆ getUnknown()

static BranchProbability llvm::BranchProbability::getUnknown ( )
inlinestatic

Definition at line 51 of file BranchProbability.h.

References BranchProbability().

Referenced by splitMBB(), and llvm::MachineBasicBlock::splitSuccessor().

◆ getZero()

static BranchProbability llvm::BranchProbability::getZero ( )
inlinestatic

Definition at line 49 of file BranchProbability.h.

References BranchProbability().

Referenced by llvm::X86FrameLowering::adjustForSegmentedStacks(), llvm::SwitchCG::SwitchLowering::buildBitTests(), llvm::SwitchCG::SwitchLowering::buildJumpTable(), llvm::PPCTargetLowering::emitEHSjLjSetJmp(), llvm::BranchProbabilityInfo::getEdgeProbability(), llvm::MachineBasicBlock::getSuccProbability(), normalizeProbabilities(), and scaleCaseProbality().

◆ isUnknown()

bool llvm::BranchProbability::isUnknown ( ) const
inline

Definition at line 47 of file BranchProbability.h.

References N.

Referenced by normalizeProbabilities(), print(), llvm::MachineBasicBlock::setSuccProbability(), shouldFoldCondBranchesToCommonDestination(), and splitMBB().

◆ isZero()

bool llvm::BranchProbability::isZero ( ) const
inline

Definition at line 46 of file BranchProbability.h.

References N.

◆ normalizeProbabilities()

template<class ProbabilityIter >
void llvm::BranchProbability::normalizeProbabilities ( ProbabilityIter  Begin,
ProbabilityIter  End 
)
static

Definition at line 205 of file BranchProbability.h.

References End, getDenominator(), getRaw(), getZero(), I, and isUnknown().

Referenced by llvm::SelectionDAGBuilder::FindMergedConditions(), and llvm::MachineBasicBlock::normalizeSuccProbs().

◆ operator!=()

bool llvm::BranchProbability::operator!= ( BranchProbability  RHS) const
inline

Definition at line 173 of file BranchProbability.h.

References RHS.

◆ operator*() [1/2]

BranchProbability llvm::BranchProbability::operator* ( BranchProbability  RHS) const
inline

Definition at line 148 of file BranchProbability.h.

References RHS.

◆ operator*() [2/2]

BranchProbability llvm::BranchProbability::operator* ( uint32_t  RHS) const
inline

Definition at line 154 of file BranchProbability.h.

References RHS.

◆ operator*=() [1/2]

BranchProbability & llvm::BranchProbability::operator*= ( BranchProbability  RHS)
inline

Definition at line 107 of file BranchProbability.h.

References assert(), N, and RHS.

◆ operator*=() [2/2]

BranchProbability & llvm::BranchProbability::operator*= ( uint32_t  RHS)
inline

Definition at line 114 of file BranchProbability.h.

References assert(), N, and RHS.

◆ operator+()

BranchProbability llvm::BranchProbability::operator+ ( BranchProbability  RHS) const
inline

Definition at line 136 of file BranchProbability.h.

References RHS.

◆ operator+=()

BranchProbability & llvm::BranchProbability::operator+= ( BranchProbability  RHS)
inline

Definition at line 91 of file BranchProbability.h.

References assert(), N, and RHS.

◆ operator-()

BranchProbability llvm::BranchProbability::operator- ( BranchProbability  RHS) const
inline

Definition at line 142 of file BranchProbability.h.

References RHS.

◆ operator-=()

BranchProbability & llvm::BranchProbability::operator-= ( BranchProbability  RHS)
inline

Definition at line 99 of file BranchProbability.h.

References assert(), N, and RHS.

◆ operator/() [1/2]

BranchProbability llvm::BranchProbability::operator/ ( BranchProbability  RHS) const
inline

Definition at line 160 of file BranchProbability.h.

References RHS.

◆ operator/() [2/2]

BranchProbability llvm::BranchProbability::operator/ ( uint32_t  RHS) const
inline

Definition at line 166 of file BranchProbability.h.

References RHS.

◆ operator/=() [1/2]

BranchProbability & llvm::BranchProbability::operator/= ( BranchProbability  RHS)
inline

Definition at line 121 of file BranchProbability.h.

References assert(), N, and RHS.

◆ operator/=() [2/2]

BranchProbability & llvm::BranchProbability::operator/= ( uint32_t  RHS)
inline

Definition at line 128 of file BranchProbability.h.

References assert(), N, and RHS.

◆ operator<()

bool llvm::BranchProbability::operator< ( BranchProbability  RHS) const
inline

Definition at line 175 of file BranchProbability.h.

References assert(), N, and RHS.

◆ operator<=()

bool llvm::BranchProbability::operator<= ( BranchProbability  RHS) const
inline

Definition at line 187 of file BranchProbability.h.

References assert(), N, and RHS.

◆ operator==()

bool llvm::BranchProbability::operator== ( BranchProbability  RHS) const
inline

Definition at line 172 of file BranchProbability.h.

References N, and RHS.

◆ operator>()

bool llvm::BranchProbability::operator> ( BranchProbability  RHS) const
inline

Definition at line 181 of file BranchProbability.h.

References assert(), N, and RHS.

◆ operator>=()

bool llvm::BranchProbability::operator>= ( BranchProbability  RHS) const
inline

Definition at line 193 of file BranchProbability.h.

References assert(), N, and RHS.

◆ print()

raw_ostream & BranchProbability::print ( raw_ostream &  OS) const

Definition at line 25 of file BranchProbability.cpp.

References llvm::format(), isUnknown(), OS, and llvm::Percent.

Referenced by dump(), and llvm::operator<<().

◆ scale()

uint64_t BranchProbability::scale ( uint64_t  Num) const

Scale a large integer.

Scales Num. Guarantees full precision. Returns the floor of the result.

Returns
Num times this.

Definition at line 107 of file BranchProbability.cpp.

Referenced by llvm::ARMBaseInstrInfo::isProfitableToIfCvt(), llvm::BlockFrequency::operator*=(), and scaleCaseProbality().

◆ scaleByInverse()

uint64_t BranchProbability::scaleByInverse ( uint64_t  Num) const

Scale a large integer by the inverse.

Scales Num by the inverse of this. Guarantees full precision. Returns the floor of the result.

Returns
Num divided by this.

Definition at line 111 of file BranchProbability.cpp.

Referenced by llvm::BlockFrequency::operator/=().

The documentation for this class was generated from the following files:
Generated on Sat Nov 9 2024 19:51:32 for LLVM by doxygen 1.9.6