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

#include "llvm/ProfileData/SampleProf.h"

Classes

struct  Hash
 

Public Member Functions

 SampleContext ()
 
 SampleContext (StringRef Name)
 
 SampleContext (FunctionId Func)
 
 SampleContext (SampleContextFrames Context, ContextStateMask CState=RawContext)
 
 SampleContext (StringRef ContextStr, std::list< SampleContextFrameVector > &CSNameTable, ContextStateMask CState=RawContext)
 
 operator SampleContextFrames () const
 
bool hasAttribute (ContextAttributeMask A)
 
void setAttribute (ContextAttributeMask A)
 
uint32_t getAllAttributes ()
 
void setAllAttributes (uint32_t A)
 
bool hasState (ContextStateMask S)
 
void setState (ContextStateMask S)
 
void clearState (ContextStateMask S)
 
bool hasContext () const
 
bool isBaseContext () const
 
FunctionId getFunction () const
 
SampleContextFrames getContextFrames () const
 
std::string toString () const
 
uint64_t getHashCode () const
 
void setFunction (FunctionId NewFunctionID)
 Set the name of the function and clear the current context.
 
void setContext (SampleContextFrames Context, ContextStateMask CState=RawContext)
 
bool operator== (const SampleContext &That) const
 
bool operator!= (const SampleContext &That) const
 
bool operator< (const SampleContext &That) const
 
bool isPrefixOf (const SampleContext &That) const
 

Static Public Member Functions

static void createCtxVectorFromStr (StringRef ContextStr, SampleContextFrameVector &Context)
 Create a context vector from a given context string and save it in Context.
 
static void decodeContextString (StringRef ContextStr, FunctionId &Func, LineLocation &LineLoc)
 
static std::string getContextString (SampleContextFrames Context, bool IncludeLeafLineLocation=false)
 

Detailed Description

Definition at line 523 of file SampleProf.h.

Constructor & Destructor Documentation

◆ SampleContext() [1/5]

llvm::sampleprof::SampleContext::SampleContext ( )
inline

Definition at line 525 of file SampleProf.h.

◆ SampleContext() [2/5]

llvm::sampleprof::SampleContext::SampleContext ( StringRef  Name)
inline

Definition at line 527 of file SampleProf.h.

References assert(), and Name.

◆ SampleContext() [3/5]

llvm::sampleprof::SampleContext::SampleContext ( FunctionId  Func)
inline

Definition at line 532 of file SampleProf.h.

◆ SampleContext() [4/5]

llvm::sampleprof::SampleContext::SampleContext ( SampleContextFrames  Context,
ContextStateMask  CState = RawContext 
)
inline

Definition at line 535 of file SampleProf.h.

References assert(), llvm::ArrayRef< T >::empty(), and setContext().

◆ SampleContext() [5/5]

llvm::sampleprof::SampleContext::SampleContext ( StringRef  ContextStr,
std::list< SampleContextFrameVector > &  CSNameTable,
ContextStateMask  CState = RawContext 
)
inline

Definition at line 545 of file SampleProf.h.

References assert(), llvm::SmallVectorTemplateCommon< T, typename >::back(), createCtxVectorFromStr(), llvm::StringRef::empty(), setContext(), llvm::StringRef::starts_with(), and llvm::sampleprof::UnknownContext.

Member Function Documentation

◆ clearState()

void llvm::sampleprof::SampleContext::clearState ( ContextStateMask  S)
inline

Definition at line 614 of file SampleProf.h.

◆ createCtxVectorFromStr()

static void llvm::sampleprof::SampleContext::createCtxVectorFromStr ( StringRef  ContextStr,
SampleContextFrameVector &  Context 
)
inlinestatic

Create a context vector from a given context string and save it in Context.

Definition at line 566 of file SampleProf.h.

References decodeContextString(), llvm::SmallVectorImpl< T >::emplace_back(), llvm::StringRef::empty(), llvm::StringRef::size(), llvm::StringRef::split(), and llvm::StringRef::substr().

Referenced by SampleContext().

◆ decodeContextString()

static void llvm::sampleprof::SampleContext::decodeContextString ( StringRef  ContextStr,
FunctionId &  Func,
LineLocation &  LineLoc 
)
inlinestatic

Definition at line 585 of file SampleProf.h.

References llvm::sampleprof::LineLocation::Discriminator, llvm::sampleprof::LineLocation::LineOffset, and llvm::StringRef::split().

Referenced by createCtxVectorFromStr().

◆ getAllAttributes()

uint32_t llvm::sampleprof::SampleContext::getAllAttributes ( )
inline

Definition at line 610 of file SampleProf.h.

Referenced by llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeFuncMetadata(), and llvm::sampleprof::SampleProfileWriterText::writeSample().

◆ getContextFrames()

SampleContextFrames llvm::sampleprof::SampleContext::getContextFrames ( ) const
inline

Definition at line 618 of file SampleProf.h.

Referenced by llvm::sampleprof::SampleProfileWriterExtBinaryBase::addContext(), getHashCode(), and llvm::SampleContextTracker::getOrCreateContextPath().

◆ getContextString()

static std::string llvm::sampleprof::SampleContext::getContextString ( SampleContextFrames  Context,
bool  IncludeLeafLineLocation = false 
)
inlinestatic

Definition at line 620 of file SampleProf.h.

References I, and llvm::ArrayRef< T >::size().

Referenced by llvm::SampleContextTracker::getContextString(), and toString().

◆ getFunction()

FunctionId llvm::sampleprof::SampleContext::getFunction ( ) const
inline

Definition at line 617 of file SampleProf.h.

Referenced by llvm::sampleprof::SampleProfileWriterBinary::addContext(), llvm::sampleprof::SampleProfileWriterExtBinaryBase::addContext(), llvm::sampleprof::FunctionSamples::getFunction(), getHashCode(), llvm::sampleprof::FunctionSamples::merge(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readFuncProfiles(), llvm::sampleprof::SampleProfileWriterBinary::writeContextIdx(), and llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeContextIdx().

◆ getHashCode()

uint64_t llvm::sampleprof::SampleContext::getHashCode ( ) const
inline

Definition at line 639 of file SampleProf.h.

References getContextFrames(), getFunction(), llvm::sampleprof::FunctionId::getHashCode(), hasContext(), and llvm::sampleprof::hash_value().

Referenced by llvm::DenseMapInfo< SampleContext >::getHashValue(), llvm::sampleprof::hash_value(), llvm::sampleprof::SampleContext::Hash::operator()(), llvm::sampleprof::SampleProfileReaderExtBinaryBase::readFuncMetadata(), and llvm::sampleprof::SampleProfileReaderBinary::readSampleContextFromTable().

◆ hasAttribute()

bool llvm::sampleprof::SampleContext::hasAttribute ( ContextAttributeMask  A)
inline

Definition at line 608 of file SampleProf.h.

References A.

◆ hasContext()

bool llvm::sampleprof::SampleContext::hasContext ( ) const
inline

Definition at line 615 of file SampleProf.h.

References llvm::sampleprof::UnknownContext.

Referenced by llvm::sampleprof::SampleProfileWriterExtBinaryBase::addContext(), getHashCode(), operator<(), llvm::sampleprof::SampleProfileReaderText::readImpl(), toString(), llvm::sampleprof::SampleProfileWriterBinary::writeContextIdx(), and llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeContextIdx().

◆ hasState()

bool llvm::sampleprof::SampleContext::hasState ( ContextStateMask  S)
inline

Definition at line 612 of file SampleProf.h.

Referenced by llvm::SampleContextTracker::getBaseSamplesFor(), and llvm::SampleContextTracker::promoteMergeContextSamplesTree().

◆ isBaseContext()

bool llvm::sampleprof::SampleContext::isBaseContext ( ) const
inline

Definition at line 616 of file SampleProf.h.

References llvm::ArrayRef< T >::size().

Referenced by llvm::sampleprof::SampleContextTrimmer::trimAndMergeColdContextProfiles().

◆ isPrefixOf()

bool llvm::sampleprof::SampleContext::isPrefixOf ( const SampleContext &  That) const
inline

Definition at line 696 of file SampleProf.h.

References llvm::ArrayRef< T >::drop_back(), and llvm::ArrayRef< T >::take_front().

Referenced by llvm::sampleprof::SampleProfileReaderExtBinaryBase::readFuncProfiles().

◆ operator SampleContextFrames()

llvm::sampleprof::SampleContext::operator SampleContextFrames ( ) const
inline

Definition at line 607 of file SampleProf.h.

◆ operator!=()

bool llvm::sampleprof::SampleContext::operator!= ( const SampleContext &  That) const
inline

Definition at line 665 of file SampleProf.h.

◆ operator<()

bool llvm::sampleprof::SampleContext::operator< ( const SampleContext &  That) const
inline

Definition at line 667 of file SampleProf.h.

References hasContext(), I, and llvm::ArrayRef< T >::size().

◆ operator==()

bool llvm::sampleprof::SampleContext::operator== ( const SampleContext &  That) const
inline

Definition at line 660 of file SampleProf.h.

◆ setAllAttributes()

void llvm::sampleprof::SampleContext::setAllAttributes ( uint32_t  A)
inline

Definition at line 611 of file SampleProf.h.

References A.

Referenced by llvm::sampleprof::SampleProfileReaderExtBinaryBase::readFuncMetadata(), and llvm::sampleprof::SampleProfileReaderText::readImpl().

◆ setAttribute()

void llvm::sampleprof::SampleContext::setAttribute ( ContextAttributeMask  A)
inline

Definition at line 609 of file SampleProf.h.

References A.

◆ setContext()

void llvm::sampleprof::SampleContext::setContext ( SampleContextFrames  Context,
ContextStateMask  CState = RawContext 
)
inline

Definition at line 652 of file SampleProf.h.

References assert(), llvm::ArrayRef< T >::back(), llvm::sampleprof::SampleContextFrame::Func, and llvm::sampleprof::UnknownContext.

Referenced by SampleContext().

◆ setFunction()

void llvm::sampleprof::SampleContext::setFunction ( FunctionId  NewFunctionID)
inline

Set the name of the function and clear the current context.

Definition at line 646 of file SampleProf.h.

References llvm::sampleprof::UnknownContext.

Referenced by llvm::sampleprof::FunctionSamples::setFunction().

◆ setState()

void llvm::sampleprof::SampleContext::setState ( ContextStateMask  S)
inline

Definition at line 613 of file SampleProf.h.

Referenced by llvm::SampleContextTracker::getContextSamplesFor(), llvm::SampleContextTracker::markContextSamplesInlined(), llvm::SampleContextTracker::populateFuncToCtxtMap(), and llvm::sampleprof::FunctionSamples::setContextSynthetic().

◆ toString()

std::string llvm::sampleprof::SampleContext::toString ( ) const
inline

Definition at line 633 of file SampleProf.h.

References getContextString(), hasContext(), and llvm::sampleprof::FunctionId::str().

Referenced by llvm::sampleprof::operator<<(), llvm::SampleContextTracker::SampleContextTracker(), and llvm::sampleprof::SampleProfileWriterText::writeSample().

The documentation for this class was generated from the following file:
Generated on Sat Apr 26 2025 15:54:17 for LLVM by doxygen 1.9.6