#ifndef LLVM_PROFILEDATA_SAMPLEPROF_H_
#define LLVM_PROFILEDATA_SAMPLEPROF_H_
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/ErrorOr.h"
#include "llvm/Support/raw_ostream.h"
#include <map>
#include <system_error>
namespace llvm {
const std::error_category &sampleprof_category();
enum class sampleprof_error {
success = 0,
bad_magic,
unsupported_version,
too_large,
truncated,
malformed,
unrecognized_format,
unsupported_writing_format,
truncated_name_table,
not_implemented,
counter_overflow
};
inline std::error_code make_error_code(sampleprof_error E) {
return std::error_code(static_cast<int>(E), sampleprof_category());
}
inline sampleprof_error MergeResult(sampleprof_error &Accumulator,
sampleprof_error Result) {
if (Accumulator == sampleprof_error::success &&
Result != sampleprof_error::success)
Accumulator = Result;
return Accumulator;
}
}
namespace std {
template <>
struct is_error_code_enum<llvm::sampleprof_error> : std::true_type {};
}
namespace llvm {
namespace sampleprof {
static inline uint64_t SPMagic() {
return uint64_t('S') << (64 - 8) | uint64_t('P') << (64 - 16) |
uint64_t('R') << (64 - 24) | uint64_t('O') << (64 - 32) |
uint64_t('F') << (64 - 40) | uint64_t('4') << (64 - 48) |
uint64_t('2') << (64 - 56) | uint64_t(0xff);
}
static inline uint64_t SPVersion() { return 102; }
struct LineLocation {
LineLocation(uint32_t L, uint32_t D) : LineOffset(L), Discriminator(D) {}
void print(raw_ostream &OS) const;
void dump() const;
bool operator<(const LineLocation &O) const {
return LineOffset < O.LineOffset ||
(LineOffset == O.LineOffset && Discriminator < O.Discriminator);
}
uint32_t LineOffset;
uint32_t Discriminator;
};
raw_ostream &operator<<(raw_ostream &OS, const LineLocation &Loc);
struct CallsiteLocation : public LineLocation {
CallsiteLocation(uint32_t L, uint32_t D, StringRef N)
: LineLocation(L, D), CalleeName(N) {}
void print(raw_ostream &OS) const;
void dump() const;
StringRef CalleeName;
};
raw_ostream &operator<<(raw_ostream &OS, const CallsiteLocation &Loc);
class SampleRecord {
public:
typedef StringMap<uint64_t> CallTargetMap;
SampleRecord() : NumSamples(0), CallTargets() {}
sampleprof_error addSamples(uint64_t S, uint64_t Weight = 1) {
bool Overflowed;
NumSamples = SaturatingMultiplyAdd(S, Weight, NumSamples, &Overflowed);
return Overflowed ? sampleprof_error::counter_overflow
: sampleprof_error::success;
}
sampleprof_error addCalledTarget(StringRef F, uint64_t S,
uint64_t Weight = 1) {
uint64_t &TargetSamples = CallTargets[F];
bool Overflowed;
TargetSamples =
SaturatingMultiplyAdd(S, Weight, TargetSamples, &Overflowed);
return Overflowed ? sampleprof_error::counter_overflow
: sampleprof_error::success;
}
bool hasCalls() const { return CallTargets.size() > 0; }
uint64_t getSamples() const { return NumSamples; }
const CallTargetMap &getCallTargets() const { return CallTargets; }
sampleprof_error merge(const SampleRecord &Other, uint64_t Weight = 1) {
sampleprof_error Result = addSamples(Other.getSamples(), Weight);
for (const auto &I : Other.getCallTargets()) {
MergeResult(Result, addCalledTarget(I.first(), I.second, Weight));
}
return Result;
}
void print(raw_ostream &OS, unsigned Indent) const;
void dump() const;
private:
uint64_t NumSamples;
CallTargetMap CallTargets;
};
raw_ostream &operator<<(raw_ostream &OS, const SampleRecord &Sample);
typedef std::map<LineLocation, SampleRecord> BodySampleMap;
class FunctionSamples;
typedef std::map<CallsiteLocation, FunctionSamples> CallsiteSampleMap;
class FunctionSamples {
public:
FunctionSamples() : TotalSamples(0), TotalHeadSamples(0) {}
void print(raw_ostream &OS = dbgs(), unsigned Indent = 0) const;
void dump() const;
sampleprof_error addTotalSamples(uint64_t Num, uint64_t Weight = 1) {
bool Overflowed;
TotalSamples =
SaturatingMultiplyAdd(Num, Weight, TotalSamples, &Overflowed);
return Overflowed ? sampleprof_error::counter_overflow
: sampleprof_error::success;
}
sampleprof_error addHeadSamples(uint64_t Num, uint64_t Weight = 1) {
bool Overflowed;
TotalHeadSamples =
SaturatingMultiplyAdd(Num, Weight, TotalHeadSamples, &Overflowed);
return Overflowed ? sampleprof_error::counter_overflow
: sampleprof_error::success;
}
sampleprof_error addBodySamples(uint32_t LineOffset, uint32_t Discriminator,
uint64_t Num, uint64_t Weight = 1) {
return BodySamples[LineLocation(LineOffset, Discriminator)].addSamples(
Num, Weight);
}
sampleprof_error addCalledTargetSamples(uint32_t LineOffset,
uint32_t Discriminator,
std::string FName, uint64_t Num,
uint64_t Weight = 1) {
return BodySamples[LineLocation(LineOffset, Discriminator)].addCalledTarget(
FName, Num, Weight);
}
ErrorOr<uint64_t> findSamplesAt(uint32_t LineOffset,
uint32_t Discriminator) const {
const auto &ret = BodySamples.find(LineLocation(LineOffset, Discriminator));
if (ret == BodySamples.end())
return std::error_code();
else
return ret->second.getSamples();
}
FunctionSamples &functionSamplesAt(const CallsiteLocation &Loc) {
return CallsiteSamples[Loc];
}
const FunctionSamples *
findFunctionSamplesAt(const CallsiteLocation &Loc) const {
auto iter = CallsiteSamples.find(Loc);
if (iter == CallsiteSamples.end()) {
return nullptr;
} else {
return &iter->second;
}
}
bool empty() const { return TotalSamples == 0; }
uint64_t getTotalSamples() const { return TotalSamples; }
uint64_t getHeadSamples() const { return TotalHeadSamples; }
const BodySampleMap &getBodySamples() const { return BodySamples; }
const CallsiteSampleMap &getCallsiteSamples() const {
return CallsiteSamples;
}
sampleprof_error merge(const FunctionSamples &Other, uint64_t Weight = 1) {
sampleprof_error Result = sampleprof_error::success;
MergeResult(Result, addTotalSamples(Other.getTotalSamples(), Weight));
MergeResult(Result, addHeadSamples(Other.getHeadSamples(), Weight));
for (const auto &I : Other.getBodySamples()) {
const LineLocation &Loc = I.first;
const SampleRecord &Rec = I.second;
MergeResult(Result, BodySamples[Loc].merge(Rec, Weight));
}
for (const auto &I : Other.getCallsiteSamples()) {
const CallsiteLocation &Loc = I.first;
const FunctionSamples &Rec = I.second;
MergeResult(Result, functionSamplesAt(Loc).merge(Rec, Weight));
}
return Result;
}
private:
uint64_t TotalSamples;
uint64_t TotalHeadSamples;
BodySampleMap BodySamples;
CallsiteSampleMap CallsiteSamples;
};
raw_ostream &operator<<(raw_ostream &OS, const FunctionSamples &FS);
template <class LocationT, class SampleT> class SampleSorter {
public:
typedef std::pair<const LocationT, SampleT> SamplesWithLoc;
typedef SmallVector<const SamplesWithLoc *, 20> SamplesWithLocList;
SampleSorter(const std::map<LocationT, SampleT> &Samples) {
for (const auto &I : Samples)
V.push_back(&I);
std::stable_sort(V.begin(), V.end(),
[](const SamplesWithLoc *A, const SamplesWithLoc *B) {
return A->first < B->first;
});
}
const SamplesWithLocList &get() const { return V; }
private:
SamplesWithLocList V;
};
}
}
#endif // LLVM_PROFILEDATA_SAMPLEPROF_H_