LLVM: llvm::sampleprof::SampleContext Class Reference

LLVM 15.0.0git

#include "llvm/ProfileData/SampleProf.h"

Classes
struct	Hash

Public Member Functions
	SampleContext ()

	SampleContext (StringRef Name)

	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

StringRef	getName () const

SampleContextFrames	getContextFrames () const

std::string	toString () const

uint64_t	getHashCode () const

void	setName (StringRef FunctionName)
	Set the name of the function and clear the current context. More...

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`. More...

static void	decodeContextString (StringRef ContextStr, StringRef &FName, LineLocation &LineLoc)

static std::string	getContextString (SampleContextFrames Context, bool IncludeLeafLineLocation=false)

Detailed Description

Definition at line 501 of file SampleProf.h.

Constructor & Destructor Documentation

◆ SampleContext() [1/4]

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

inline

Definition at line 503 of file SampleProf.h.

◆ SampleContext() [2/4]

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

inline

Definition at line 505 of file SampleProf.h.

◆ SampleContext() [3/4]

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

inline

Definition at line 508 of file SampleProf.h.

References assert(), Context, and setContext().

◆ SampleContext() [4/4]

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

inline

Definition at line 518 of file SampleProf.h.

References assert(), Context, createCtxVectorFromStr(), llvm::StringRef::empty(), setContext(), llvm::StringRef::startswith(), and llvm::sampleprof::UnknownContext.

Member Function Documentation

◆ clearState()

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

inline

Definition at line 586 of file SampleProf.h.

References S.

◆ 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 539 of file SampleProf.h.

References Context, decodeContextString(), 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,
		StringRef &	FName,
		LineLocation &	LineLoc
	)

inlinestatic

Definition at line 558 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 582 of file SampleProf.h.

Referenced by llvm::sampleprof::SampleProfileWriterExtBinaryBase::writeFuncMetadata().

◆ getContextFrames()

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

inline

Definition at line 590 of file SampleProf.h.

Referenced by getHashCode(), and llvm::sampleprof::hash_value().

◆ getContextString()

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

inlinestatic

Definition at line 592 of file SampleProf.h.

References Context, and I.

Referenced by toString().

◆ getHashCode()

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

inline

Definition at line 611 of file SampleProf.h.

References getContextFrames(), getName(), hasContext(), and llvm::sampleprof::hash_value().

Referenced by llvm::DenseMapInfo< SampleContext >::getHashValue().

◆ getName()

StringRef llvm::sampleprof::SampleContext::getName ( ) const

inline

Definition at line 589 of file SampleProf.h.

Referenced by getHashCode(), llvm::sampleprof::FunctionSamples::getName(), llvm::sampleprof::hash_value(), llvm::sampleprof::FunctionSamples::merge(), and llvm::sampleprof::SampleProfileReaderExtBinaryBase::readFuncProfiles().

◆ hasAttribute()

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

inline

Definition at line 580 of file SampleProf.h.

◆ hasContext()

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

inline

Definition at line 587 of file SampleProf.h.

References llvm::sampleprof::UnknownContext.

Referenced by getHashCode(), llvm::sampleprof::hash_value(), operator<(), llvm::sampleprof::SampleProfileReaderText::readImpl(), and toString().

◆ hasState()

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

inline

Definition at line 584 of file SampleProf.h.

References S.

Referenced by llvm::SampleContextTracker::promoteMergeContextSamplesTree().

◆ isBaseContext()

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

inline

Definition at line 588 of file SampleProf.h.

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

◆ IsPrefixOf()

bool llvm::sampleprof::SampleContext::IsPrefixOf ( const SampleContext & That ) const

inline

Definition at line 667 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 579 of file SampleProf.h.

◆ operator!=()

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

inline

Definition at line 636 of file SampleProf.h.

◆ operator<()

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

inline

Definition at line 638 of file SampleProf.h.

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

◆ operator==()

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

inline

Definition at line 631 of file SampleProf.h.

◆ setAllAttributes()

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

inline

Definition at line 583 of file SampleProf.h.

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

◆ setAttribute()

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

inline

Definition at line 581 of file SampleProf.h.

◆ setContext()

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

inline

Definition at line 623 of file SampleProf.h.

References assert(), Context, and llvm::sampleprof::UnknownContext.

Referenced by SampleContext().

◆ setName()

void llvm::sampleprof::SampleContext::setName ( StringRef FunctionName )

inline

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

Definition at line 617 of file SampleProf.h.

References llvm::sampleprof::UnknownContext.

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

◆ setState()

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

inline

Definition at line 585 of file SampleProf.h.

References S.

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

◆ toString()

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

inline

Definition at line 605 of file SampleProf.h.

References getContextString(), hasContext(), and llvm::StringRef::str().

Referenced by llvm::sampleprof::SampleProfileReader::dumpFunctionProfile().

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

include/llvm/ProfileData/SampleProf.h