diff --git a/llvm/include/llvm/Analysis/ProfileSummaryInfo.h b/llvm/include/llvm/Analysis/ProfileSummaryInfo.h --- a/llvm/include/llvm/Analysis/ProfileSummaryInfo.h +++ b/llvm/include/llvm/Analysis/ProfileSummaryInfo.h @@ -134,9 +134,13 @@ bool isColdCount(uint64_t C) const; /// Returns true if count \p C is considered hot with regard to a given /// hot percentile cutoff value. + /// PercentileCutoff is encoded as a 6 digit decimal fixed point number, where + /// the first two digits are the whole part. E.g. 995000 for 99.5 percentile. bool isHotCountNthPercentile(int PercentileCutoff, uint64_t C) const; /// Returns true if count \p C is considered cold with regard to a given /// cold percentile cutoff value. + /// PercentileCutoff is encoded as a 6 digit decimal fixed point number, where + /// the first two digits are the whole part. E.g. 995000 for 99.5 percentile. bool isColdCountNthPercentile(int PercentileCutoff, uint64_t C) const; /// Returns true if BasicBlock \p BB is considered hot. bool isHotBlock(const BasicBlock *BB, BlockFrequencyInfo *BFI) const; @@ -144,10 +148,14 @@ bool isColdBlock(const BasicBlock *BB, BlockFrequencyInfo *BFI) const; /// Returns true if BasicBlock \p BB is considered hot with regard to a given /// hot percentile cutoff value. + /// PercentileCutoff is encoded as a 6 digit decimal fixed point number, where + /// the first two digits are the whole part. E.g. 995000 for 99.5 percentile. bool isHotBlockNthPercentile(int PercentileCutoff, const BasicBlock *BB, BlockFrequencyInfo *BFI) const; /// Returns true if BasicBlock \p BB is considered cold with regard to a given /// cold percentile cutoff value. + /// PercentileCutoff is encoded as a 6 digit decimal fixed point number, where + /// the first two digits are the whole part. E.g. 995000 for 99.5 percentile. bool isColdBlockNthPercentile(int PercentileCutoff, const BasicBlock *BB, BlockFrequencyInfo *BFI) const; /// Returns true if the call site \p CB is considered hot.