1 ///===- MachineOptimizationRemarkEmitter.cpp - Opt Diagnostic -*- C++ -*---===// 2 /// 3 /// The LLVM Compiler Infrastructure 4 /// 5 /// This file is distributed under the University of Illinois Open Source 6 /// License. See LICENSE.TXT for details. 7 /// 8 ///===---------------------------------------------------------------------===// 9 /// \file 10 /// Optimization diagnostic interfaces for machine passes. It's packaged as an 11 /// analysis pass so that by using this service passes become dependent on MBFI 12 /// as well. MBFI is used to compute the "hotness" of the diagnostic message. 13 /// 14 ///===---------------------------------------------------------------------===// 15 16 #include "llvm/CodeGen/MachineOptimizationRemarkEmitter.h" 17 #include "llvm/CodeGen/LazyMachineBlockFrequencyInfo.h" 18 #include "llvm/CodeGen/MachineInstr.h" 19 #include "llvm/IR/DebugInfo.h" 20 #include "llvm/IR/DiagnosticInfo.h" 21 #include "llvm/IR/LLVMContext.h" 22 23 using namespace llvm; 24 25 DiagnosticInfoMIROptimization::MachineArgument::MachineArgument( 26 StringRef MKey, const MachineInstr &MI) 27 : Argument() { 28 Key = MKey; 29 30 raw_string_ostream OS(Val); 31 MI.print(OS, /*SkipOpers=*/false, /*SkipDebugLoc=*/true); 32 } 33 34 Optional<uint64_t> 35 MachineOptimizationRemarkEmitter::computeHotness(const MachineBasicBlock &MBB) { 36 if (!MBFI) 37 return None; 38 39 return MBFI->getBlockProfileCount(&MBB); 40 } 41 42 void MachineOptimizationRemarkEmitter::computeHotness( 43 DiagnosticInfoMIROptimization &Remark) { 44 const MachineBasicBlock *MBB = Remark.getBlock(); 45 if (MBB) 46 Remark.setHotness(computeHotness(*MBB)); 47 } 48 49 void MachineOptimizationRemarkEmitter::emit( 50 DiagnosticInfoOptimizationBase &OptDiagCommon) { 51 auto &OptDiag = cast<DiagnosticInfoMIROptimization>(OptDiagCommon); 52 computeHotness(OptDiag); 53 54 LLVMContext &Ctx = MF.getFunction()->getContext(); 55 yaml::Output *Out = Ctx.getDiagnosticsOutputFile(); 56 if (Out) { 57 auto *P = &const_cast<DiagnosticInfoOptimizationBase &>(OptDiagCommon); 58 *Out << P; 59 } 60 // FIXME: now that IsVerbose is part of DI, filtering for this will be moved 61 // from here to clang. 62 if (!OptDiag.isVerbose() || shouldEmitVerbose()) 63 Ctx.diagnose(OptDiag); 64 } 65 66 MachineOptimizationRemarkEmitterPass::MachineOptimizationRemarkEmitterPass() 67 : MachineFunctionPass(ID) { 68 initializeMachineOptimizationRemarkEmitterPassPass( 69 *PassRegistry::getPassRegistry()); 70 } 71 72 bool MachineOptimizationRemarkEmitterPass::runOnMachineFunction( 73 MachineFunction &MF) { 74 MachineBlockFrequencyInfo *MBFI; 75 76 if (MF.getFunction()->getContext().getDiagnosticsHotnessRequested()) 77 MBFI = &getAnalysis<LazyMachineBlockFrequencyInfoPass>().getBFI(); 78 else 79 MBFI = nullptr; 80 81 ORE = llvm::make_unique<MachineOptimizationRemarkEmitter>(MF, MBFI); 82 return false; 83 } 84 85 void MachineOptimizationRemarkEmitterPass::getAnalysisUsage( 86 AnalysisUsage &AU) const { 87 AU.addRequired<LazyMachineBlockFrequencyInfoPass>(); 88 AU.setPreservesAll(); 89 MachineFunctionPass::getAnalysisUsage(AU); 90 } 91 92 char MachineOptimizationRemarkEmitterPass::ID = 0; 93 static const char ore_name[] = "Machine Optimization Remark Emitter"; 94 #define ORE_NAME "machine-opt-remark-emitter" 95 96 INITIALIZE_PASS_BEGIN(MachineOptimizationRemarkEmitterPass, ORE_NAME, ore_name, 97 false, true) 98 INITIALIZE_PASS_DEPENDENCY(LazyMachineBlockFrequencyInfoPass) 99 INITIALIZE_PASS_END(MachineOptimizationRemarkEmitterPass, ORE_NAME, ore_name, 100 false, true) 101