llvm::sampleprof::SampleRecord Class Reference

Representation of a single sample record. More...

#include "llvm/ProfileData/SampleProf.h"

Classes
struct	CallTargetComparator

Public Types
using	CallTarget = std::pair< StringRef, uint64_t >
using	SortedCallTargetSet = std::set< CallTarget, CallTargetComparator >
using	CallTargetMap = StringMap< uint64_t >

Public Member Functions
	SampleRecord ()=default
sampleprof_error	addSamples (uint64_t S, uint64_t Weight=1)
	Increment the number of samples for this record by S. More...
sampleprof_error	addCalledTarget (StringRef F, uint64_t S, uint64_t Weight=1)
	Add called function F with samples S. More...
bool	hasCalls () const
	Return true if this sample record contains function calls. More...
uint64_t	getSamples () const
const CallTargetMap &	getCallTargets () const
const SortedCallTargetSet	getSortedCallTargets () const
sampleprof_error	merge (const SampleRecord &Other, uint64_t Weight=1)
	Merge the samples in Other into this record. More...
void	print (raw_ostream &OS, unsigned Indent) const
	Print the sample record to the stream OS indented by Indent. More...
void	dump () const

Static Public Member Functions
static const SortedCallTargetSet	SortCallTargets (const CallTargetMap &Targets)
	Sort call targets in descending order of call frequency. More...
static const CallTargetMap	adjustCallTargets (const CallTargetMap &Targets, float DistributionFactor)
	Prorate call targets by a distribution factor. More...

Detailed Description

Representation of a single sample record.

A sample record is represented by a positive integer value, which indicates how frequently was the associated line location executed.

Additionally, if the associated location contains a function call, the record will hold a list of all the possible called targets. For direct calls, this will be the exact function being invoked. For indirect calls (function pointers, virtual table dispatch), this will be a list of one or more functions.

Definition at line 318 of file SampleProf.h.

Member Typedef Documentation

CallTarget

using llvm::sampleprof::SampleRecord::CallTarget = std::pair<StringRef, uint64_t>

Definition at line 320 of file SampleProf.h.

CallTargetMap

using llvm::sampleprof::SampleRecord::CallTargetMap = StringMap<uint64_t>

Definition at line 331 of file SampleProf.h.

SortedCallTargetSet

using llvm::sampleprof::SampleRecord::SortedCallTargetSet = std::set<CallTarget, CallTargetComparator>

Definition at line 330 of file SampleProf.h.

Constructor & Destructor Documentation

SampleRecord()

llvm::sampleprof::SampleRecord::SampleRecord ( )

default

Member Function Documentation

addCalledTarget()

sampleprof_error llvm::sampleprof::SampleRecord::addCalledTarget ( StringRef  F, uint64_t  S, uint64_t  Weight = 1  )

inline

Add called function F with samples S.

Optionally scale sample count S by Weight.

Sample counts accumulate using saturating arithmetic, to avoid wrapping around unsigned integers.

Definition at line 351 of file SampleProf.h.

References llvm::counter_overflow, F, S, llvm::SaturatingMultiplyAdd(), and llvm::success.

Referenced by merge().

addSamples()

sampleprof_error llvm::sampleprof::SampleRecord::addSamples ( uint64_t  S, uint64_t  Weight = 1  )

inline

Increment the number of samples for this record by S.

Optionally scale sample count S by Weight.

Sample counts accumulate using saturating arithmetic, to avoid wrapping around unsigned integers.

Definition at line 339 of file SampleProf.h.

References llvm::counter_overflow, S, llvm::SaturatingMultiplyAdd(), and llvm::success.

Referenced by merge().

adjustCallTargets()

static const CallTargetMap llvm::sampleprof::SampleRecord::adjustCallTargets ( const CallTargetMap &  Targets, float  DistributionFactor  )

inlinestatic

Prorate call targets by a distribution factor.

Definition at line 380 of file SampleProf.h.

References I.

dump()

LLVM_DUMP_METHOD void SampleRecord::dump

(

)

const

Definition at line 152 of file SampleProf.cpp.

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

getCallTargets()

const CallTargetMap& llvm::sampleprof::SampleRecord::getCallTargets ( ) const

inline

Definition at line 365 of file SampleProf.h.

Referenced by llvm::sampleprof::SampleProfileWriterBinary::addNames(), and llvm::sampleprof::SampleProfileWriterBinary::writeBody().

getSamples()

uint64_t llvm::sampleprof::SampleRecord::getSamples ( ) const

inline

Definition at line 364 of file SampleProf.h.

Referenced by llvm::sampleprof::SampleProfileWriterBinary::writeBody(), and llvm::sampleprof::SampleProfileWriterText::writeSample().

getSortedCallTargets()

const SortedCallTargetSet llvm::sampleprof::SampleRecord::getSortedCallTargets ( ) const

inline

Definition at line 366 of file SampleProf.h.

References SortCallTargets().

Referenced by print(), llvm::sampleprof::SampleProfileWriterBinary::writeBody(), and llvm::sampleprof::SampleProfileWriterText::writeSample().

hasCalls()

bool llvm::sampleprof::SampleRecord::hasCalls ( ) const

inline

Return true if this sample record contains function calls.

Definition at line 362 of file SampleProf.h.

References llvm::StringMapImpl::empty().

Referenced by print().

merge()

sampleprof_error SampleRecord::merge	(	const SampleRecord &	Other,
		uint64_t	Weight = 1
	)

Merge the samples in Other into this record.

Optionally scale sample counts by Weight.

Definition at line 126 of file SampleProf.cpp.

References addCalledTarget(), addSamples(), I, llvm::MergeResult(), and Other.

print()

void SampleRecord::print	(	raw_ostream &	OS,
		unsigned	Indent
	)		const

Print the sample record to the stream OS indented by Indent.

Definition at line 141 of file SampleProf.cpp.

References getSortedCallTargets(), hasCalls(), and I.

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

SortCallTargets()

static const SortedCallTargetSet llvm::sampleprof::SampleRecord::SortCallTargets ( const CallTargetMap &  Targets )

inlinestatic

Sort call targets in descending order of call frequency.

Definition at line 371 of file SampleProf.h.

References I.

Referenced by getSortedCallTargets(), and GetSortedValueDataFromCallTargets().

---

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

• include/llvm/ProfileData/SampleProf.h
• lib/ProfileData/SampleProf.cpp