2017-01-26 07:20:33 +08:00
|
|
|
///===- MachineOptimizationRemarkEmitter.cpp - Opt Diagnostic -*- C++ -*---===//
|
|
|
|
///
|
|
|
|
/// The LLVM Compiler Infrastructure
|
|
|
|
///
|
|
|
|
/// This file is distributed under the University of Illinois Open Source
|
|
|
|
/// License. See LICENSE.TXT for details.
|
|
|
|
///
|
|
|
|
///===---------------------------------------------------------------------===//
|
|
|
|
/// \file
|
|
|
|
/// Optimization diagnostic interfaces for machine passes. It's packaged as an
|
|
|
|
/// analysis pass so that by using this service passes become dependent on MBFI
|
|
|
|
/// as well. MBFI is used to compute the "hotness" of the diagnostic message.
|
|
|
|
///
|
|
|
|
///===---------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#include "llvm/CodeGen/MachineOptimizationRemarkEmitter.h"
|
2017-02-15 01:21:09 +08:00
|
|
|
#include "llvm/CodeGen/LazyMachineBlockFrequencyInfo.h"
|
2017-02-24 05:05:33 +08:00
|
|
|
#include "llvm/CodeGen/MachineInstr.h"
|
2017-01-26 07:20:33 +08:00
|
|
|
#include "llvm/IR/DebugInfo.h"
|
|
|
|
#include "llvm/IR/DiagnosticInfo.h"
|
|
|
|
#include "llvm/IR/LLVMContext.h"
|
|
|
|
|
|
|
|
using namespace llvm;
|
|
|
|
|
2017-02-24 05:05:33 +08:00
|
|
|
DiagnosticInfoMIROptimization::MachineArgument::MachineArgument(
|
|
|
|
StringRef MKey, const MachineInstr &MI)
|
|
|
|
: Argument() {
|
|
|
|
Key = MKey;
|
|
|
|
|
|
|
|
raw_string_ostream OS(Val);
|
|
|
|
MI.print(OS, /*SkipOpers=*/false, /*SkipDebugLoc=*/true);
|
|
|
|
}
|
|
|
|
|
2017-01-26 07:20:33 +08:00
|
|
|
Optional<uint64_t>
|
|
|
|
MachineOptimizationRemarkEmitter::computeHotness(const MachineBasicBlock &MBB) {
|
|
|
|
if (!MBFI)
|
|
|
|
return None;
|
|
|
|
|
|
|
|
return MBFI->getBlockProfileCount(&MBB);
|
|
|
|
}
|
|
|
|
|
|
|
|
void MachineOptimizationRemarkEmitter::computeHotness(
|
|
|
|
DiagnosticInfoMIROptimization &Remark) {
|
|
|
|
const MachineBasicBlock *MBB = Remark.getBlock();
|
|
|
|
if (MBB)
|
|
|
|
Remark.setHotness(computeHotness(*MBB));
|
|
|
|
}
|
|
|
|
|
|
|
|
void MachineOptimizationRemarkEmitter::emit(
|
|
|
|
DiagnosticInfoOptimizationBase &OptDiagCommon) {
|
|
|
|
auto &OptDiag = cast<DiagnosticInfoMIROptimization>(OptDiagCommon);
|
|
|
|
computeHotness(OptDiag);
|
|
|
|
|
|
|
|
LLVMContext &Ctx = MF.getFunction()->getContext();
|
2017-07-01 07:14:53 +08:00
|
|
|
|
|
|
|
// If a diagnostic has a hotness value, then only emit it if its hotness
|
|
|
|
// meets the threshold.
|
|
|
|
if (OptDiag.getHotness() &&
|
|
|
|
*OptDiag.getHotness() < Ctx.getDiagnosticsHotnessThreshold()) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2017-01-26 07:20:33 +08:00
|
|
|
yaml::Output *Out = Ctx.getDiagnosticsOutputFile();
|
|
|
|
if (Out) {
|
|
|
|
auto *P = &const_cast<DiagnosticInfoOptimizationBase &>(OptDiagCommon);
|
|
|
|
*Out << P;
|
|
|
|
}
|
|
|
|
// FIXME: now that IsVerbose is part of DI, filtering for this will be moved
|
|
|
|
// from here to clang.
|
|
|
|
if (!OptDiag.isVerbose() || shouldEmitVerbose())
|
|
|
|
Ctx.diagnose(OptDiag);
|
|
|
|
}
|
|
|
|
|
|
|
|
MachineOptimizationRemarkEmitterPass::MachineOptimizationRemarkEmitterPass()
|
|
|
|
: MachineFunctionPass(ID) {
|
|
|
|
initializeMachineOptimizationRemarkEmitterPassPass(
|
|
|
|
*PassRegistry::getPassRegistry());
|
|
|
|
}
|
|
|
|
|
|
|
|
bool MachineOptimizationRemarkEmitterPass::runOnMachineFunction(
|
|
|
|
MachineFunction &MF) {
|
|
|
|
MachineBlockFrequencyInfo *MBFI;
|
|
|
|
|
[ORE] Unify spelling as "diagnostics hotness"
Summary:
To enable profile hotness information in diagnostics output, Clang takes
the option `-fdiagnostics-show-hotness` -- that's "diagnostics", with an
"s" at the end. Clang also defines `CodeGenOptions::DiagnosticsWithHotness`.
LLVM, on the other hand, defines
`LLVMContext::getDiagnosticHotnessRequested` -- that's "diagnostic", not
"diagnostics". It's a small difference, but it's confusing, typo-inducing, and
frustrating.
Add a new method with the spelling "diagnostics", and "deprecate" the
old spelling.
Reviewers: anemet, davidxl
Reviewed By: anemet
Subscribers: llvm-commits, mehdi_amini
Differential Revision: https://reviews.llvm.org/D34864
llvm-svn: 306848
2017-07-01 02:13:59 +08:00
|
|
|
if (MF.getFunction()->getContext().getDiagnosticsHotnessRequested())
|
2017-02-15 01:21:09 +08:00
|
|
|
MBFI = &getAnalysis<LazyMachineBlockFrequencyInfoPass>().getBFI();
|
2017-01-26 07:20:33 +08:00
|
|
|
else
|
|
|
|
MBFI = nullptr;
|
|
|
|
|
|
|
|
ORE = llvm::make_unique<MachineOptimizationRemarkEmitter>(MF, MBFI);
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
void MachineOptimizationRemarkEmitterPass::getAnalysisUsage(
|
|
|
|
AnalysisUsage &AU) const {
|
2017-02-24 01:30:01 +08:00
|
|
|
AU.addRequired<LazyMachineBlockFrequencyInfoPass>();
|
2017-01-26 07:20:33 +08:00
|
|
|
AU.setPreservesAll();
|
|
|
|
MachineFunctionPass::getAnalysisUsage(AU);
|
|
|
|
}
|
|
|
|
|
|
|
|
char MachineOptimizationRemarkEmitterPass::ID = 0;
|
|
|
|
static const char ore_name[] = "Machine Optimization Remark Emitter";
|
|
|
|
#define ORE_NAME "machine-opt-remark-emitter"
|
|
|
|
|
|
|
|
INITIALIZE_PASS_BEGIN(MachineOptimizationRemarkEmitterPass, ORE_NAME, ore_name,
|
|
|
|
false, true)
|
2017-02-24 01:30:01 +08:00
|
|
|
INITIALIZE_PASS_DEPENDENCY(LazyMachineBlockFrequencyInfoPass)
|
2017-01-26 07:20:33 +08:00
|
|
|
INITIALIZE_PASS_END(MachineOptimizationRemarkEmitterPass, ORE_NAME, ore_name,
|
|
|
|
false, true)
|