117 lines
4.0 KiB
C++
117 lines
4.0 KiB
C++
//===- Transforms/Instrumentation/PGOInstrumentation.h ----------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
/// \file
|
|
/// This file provides the interface for IR based instrumentation passes (
|
|
/// (profile-gen, and profile-use).
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_TRANSFORMS_INSTRUMENTATION_PGOINSTRUMENTATION_H
|
|
#define LLVM_TRANSFORMS_INSTRUMENTATION_PGOINSTRUMENTATION_H
|
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
|
#include "llvm/ADT/IntrusiveRefCntPtr.h"
|
|
#include "llvm/IR/PassManager.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
#include "llvm/Support/Compiler.h"
|
|
#include "llvm/Support/VirtualFileSystem.h"
|
|
#include <cstdint>
|
|
#include <string>
|
|
|
|
namespace llvm {
|
|
|
|
class Function;
|
|
class Instruction;
|
|
class Module;
|
|
|
|
/// The instrumentation (profile-instr-gen) pass for IR based PGO.
|
|
// We use this pass to create COMDAT profile variables for context
|
|
// sensitive PGO (CSPGO). The reason to have a pass for this is CSPGO
|
|
// can be run after LTO/ThinLTO linking. Lld linker needs to see
|
|
// all the COMDAT variables before linking. So we have this pass
|
|
// always run before linking for CSPGO.
|
|
class PGOInstrumentationGenCreateVar
|
|
: public OptionalPassInfoMixin<PGOInstrumentationGenCreateVar> {
|
|
public:
|
|
PGOInstrumentationGenCreateVar(std::string CSInstrName = "",
|
|
bool Sampling = false)
|
|
: CSInstrName(CSInstrName), ProfileSampling(Sampling) {}
|
|
LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
|
|
|
|
private:
|
|
std::string CSInstrName;
|
|
bool ProfileSampling;
|
|
};
|
|
|
|
enum class PGOInstrumentationType { Invalid = 0, FDO, CSFDO, CTXPROF };
|
|
/// The instrumentation (profile-instr-gen) pass for IR based PGO.
|
|
class PGOInstrumentationGen
|
|
: public OptionalPassInfoMixin<PGOInstrumentationGen> {
|
|
public:
|
|
PGOInstrumentationGen(
|
|
PGOInstrumentationType InstrumentationType = PGOInstrumentationType ::FDO)
|
|
: InstrumentationType(InstrumentationType) {}
|
|
LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
|
|
|
|
private:
|
|
// If this is a context sensitive instrumentation.
|
|
const PGOInstrumentationType InstrumentationType;
|
|
};
|
|
|
|
/// The profile annotation (profile-instr-use) pass for IR based PGO.
|
|
class PGOInstrumentationUse
|
|
: public OptionalPassInfoMixin<PGOInstrumentationUse> {
|
|
public:
|
|
LLVM_ABI
|
|
PGOInstrumentationUse(std::string Filename = "",
|
|
std::string RemappingFilename = "", bool IsCS = false,
|
|
IntrusiveRefCntPtr<vfs::FileSystem> FS = nullptr);
|
|
|
|
LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
|
|
|
|
private:
|
|
std::string ProfileFileName;
|
|
std::string ProfileRemappingFileName;
|
|
// If this is a context sensitive instrumentation.
|
|
bool IsCS;
|
|
IntrusiveRefCntPtr<vfs::FileSystem> FS;
|
|
};
|
|
|
|
/// The indirect function call promotion pass.
|
|
class PGOIndirectCallPromotion
|
|
: public OptionalPassInfoMixin<PGOIndirectCallPromotion> {
|
|
public:
|
|
PGOIndirectCallPromotion(bool IsInLTO = false, bool SamplePGO = false)
|
|
: InLTO(IsInLTO), SamplePGO(SamplePGO) {}
|
|
|
|
LLVM_ABI PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
|
|
|
|
private:
|
|
bool InLTO;
|
|
bool SamplePGO;
|
|
};
|
|
|
|
/// The profile size based optimization pass for memory intrinsics.
|
|
class PGOMemOPSizeOpt : public OptionalPassInfoMixin<PGOMemOPSizeOpt> {
|
|
public:
|
|
PGOMemOPSizeOpt() = default;
|
|
|
|
LLVM_ABI PreservedAnalyses run(Function &F, FunctionAnalysisManager &MAM);
|
|
};
|
|
|
|
LLVM_ABI void setProfMetadata(Instruction *TI, ArrayRef<uint64_t> EdgeCounts,
|
|
uint64_t MaxCount);
|
|
|
|
LLVM_ABI void setIrrLoopHeaderMetadata(Module *M, Instruction *TI,
|
|
uint64_t Count);
|
|
|
|
} // end namespace llvm
|
|
|
|
#endif // LLVM_TRANSFORMS_INSTRUMENTATION_PGOINSTRUMENTATION_H
|