108 lines
4.2 KiB
C++
108 lines
4.2 KiB
C++
//===- llvm/Transforms/Utils/SizeOpts.h - size optimization -----*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file contains some shared code size optimization related code.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_TRANSFORMS_UTILS_SIZEOPTS_H
|
|
#define LLVM_TRANSFORMS_UTILS_SIZEOPTS_H
|
|
|
|
#include "llvm/Analysis/BlockFrequencyInfo.h"
|
|
#include "llvm/Analysis/ProfileSummaryInfo.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
|
|
extern llvm::cl::opt<bool> EnablePGSO;
|
|
extern llvm::cl::opt<bool> PGSOLargeWorkingSetSizeOnly;
|
|
extern llvm::cl::opt<bool> PGSOColdCodeOnly;
|
|
extern llvm::cl::opt<bool> PGSOColdCodeOnlyForInstrPGO;
|
|
extern llvm::cl::opt<bool> PGSOColdCodeOnlyForSamplePGO;
|
|
extern llvm::cl::opt<bool> PGSOColdCodeOnlyForPartialSamplePGO;
|
|
extern llvm::cl::opt<bool> ForcePGSO;
|
|
extern llvm::cl::opt<int> PgsoCutoffInstrProf;
|
|
extern llvm::cl::opt<int> PgsoCutoffSampleProf;
|
|
|
|
namespace llvm {
|
|
|
|
class BasicBlock;
|
|
class BlockFrequencyInfo;
|
|
class Function;
|
|
|
|
enum class PGSOQueryType {
|
|
IRPass, // A query call from an IR-level transform pass.
|
|
Test, // A query call from a unit test.
|
|
Other, // Others.
|
|
};
|
|
|
|
static inline bool isPGSOColdCodeOnly(ProfileSummaryInfo *PSI) {
|
|
return PGSOColdCodeOnly ||
|
|
(PSI->hasInstrumentationProfile() && PGSOColdCodeOnlyForInstrPGO) ||
|
|
(PSI->hasSampleProfile() &&
|
|
((!PSI->hasPartialSampleProfile() && PGSOColdCodeOnlyForSamplePGO) ||
|
|
(PSI->hasPartialSampleProfile() &&
|
|
PGSOColdCodeOnlyForPartialSamplePGO))) ||
|
|
(PGSOLargeWorkingSetSizeOnly && !PSI->hasLargeWorkingSetSize());
|
|
}
|
|
|
|
template<typename AdapterT, typename FuncT, typename BFIT>
|
|
bool shouldFuncOptimizeForSizeImpl(const FuncT *F, ProfileSummaryInfo *PSI,
|
|
BFIT *BFI, PGSOQueryType QueryType) {
|
|
assert(F);
|
|
if (!PSI || !BFI || !PSI->hasProfileSummary())
|
|
return false;
|
|
if (ForcePGSO)
|
|
return true;
|
|
if (!EnablePGSO)
|
|
return false;
|
|
if (isPGSOColdCodeOnly(PSI))
|
|
return AdapterT::isFunctionColdInCallGraph(F, PSI, *BFI);
|
|
if (PSI->hasSampleProfile())
|
|
// The "isCold" check seems to work better for Sample PGO as it could have
|
|
// many profile-unannotated functions.
|
|
return AdapterT::isFunctionColdInCallGraphNthPercentile(
|
|
PgsoCutoffSampleProf, F, PSI, *BFI);
|
|
return !AdapterT::isFunctionHotInCallGraphNthPercentile(PgsoCutoffInstrProf,
|
|
F, PSI, *BFI);
|
|
}
|
|
|
|
template<typename AdapterT, typename BlockTOrBlockFreq, typename BFIT>
|
|
bool shouldOptimizeForSizeImpl(BlockTOrBlockFreq BBOrBlockFreq, ProfileSummaryInfo *PSI,
|
|
BFIT *BFI, PGSOQueryType QueryType) {
|
|
if (!PSI || !BFI || !PSI->hasProfileSummary())
|
|
return false;
|
|
if (ForcePGSO)
|
|
return true;
|
|
if (!EnablePGSO)
|
|
return false;
|
|
if (isPGSOColdCodeOnly(PSI))
|
|
return AdapterT::isColdBlock(BBOrBlockFreq, PSI, BFI);
|
|
if (PSI->hasSampleProfile())
|
|
// The "isCold" check seems to work better for Sample PGO as it could have
|
|
// many profile-unannotated functions.
|
|
return AdapterT::isColdBlockNthPercentile(PgsoCutoffSampleProf,
|
|
BBOrBlockFreq, PSI, BFI);
|
|
return !AdapterT::isHotBlockNthPercentile(PgsoCutoffInstrProf, BBOrBlockFreq,
|
|
PSI, BFI);
|
|
}
|
|
|
|
/// Returns true if function \p F is suggested to be size-optimized based on the
|
|
/// profile.
|
|
bool shouldOptimizeForSize(const Function *F, ProfileSummaryInfo *PSI,
|
|
BlockFrequencyInfo *BFI,
|
|
PGSOQueryType QueryType = PGSOQueryType::Other);
|
|
|
|
/// Returns true if basic block \p BB is suggested to be size-optimized based on
|
|
/// the profile.
|
|
bool shouldOptimizeForSize(const BasicBlock *BB, ProfileSummaryInfo *PSI,
|
|
BlockFrequencyInfo *BFI,
|
|
PGSOQueryType QueryType = PGSOQueryType::Other);
|
|
|
|
} // end namespace llvm
|
|
|
|
#endif // LLVM_TRANSFORMS_UTILS_SIZEOPTS_H
|