Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 1 | //===- OptimizationDiagnosticInfo.cpp - Optimization 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 | // |
| 10 | // Optimization diagnostic interfaces. It's packaged as an analysis pass so |
| 11 | // that by using this service passes become dependent on BFI as well. BFI is |
| 12 | // used to compute the "hotness" of the diagnostic message. |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
| 15 | #include "llvm/Analysis/OptimizationDiagnosticInfo.h" |
Adam Nemet | 896c09b | 2016-08-10 00:44:44 +0000 | [diff] [blame] | 16 | #include "llvm/Analysis/BranchProbabilityInfo.h" |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 17 | #include "llvm/Analysis/LazyBlockFrequencyInfo.h" |
| 18 | #include "llvm/Analysis/LoopInfo.h" |
Adam Nemet | a62b7e1 | 2016-09-27 20:55:07 +0000 | [diff] [blame] | 19 | #include "llvm/IR/DebugInfo.h" |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 20 | #include "llvm/IR/DiagnosticInfo.h" |
Adam Nemet | 896c09b | 2016-08-10 00:44:44 +0000 | [diff] [blame] | 21 | #include "llvm/IR/Dominators.h" |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 22 | #include "llvm/IR/LLVMContext.h" |
| 23 | |
| 24 | using namespace llvm; |
| 25 | |
Adam Nemet | 896c09b | 2016-08-10 00:44:44 +0000 | [diff] [blame] | 26 | OptimizationRemarkEmitter::OptimizationRemarkEmitter(Function *F) |
| 27 | : F(F), BFI(nullptr) { |
| 28 | if (!F->getContext().getDiagnosticHotnessRequested()) |
| 29 | return; |
| 30 | |
| 31 | // First create a dominator tree. |
| 32 | DominatorTree DT; |
| 33 | DT.recalculate(*F); |
| 34 | |
| 35 | // Generate LoopInfo from it. |
| 36 | LoopInfo LI; |
| 37 | LI.analyze(DT); |
| 38 | |
| 39 | // Then compute BranchProbabilityInfo. |
| 40 | BranchProbabilityInfo BPI; |
| 41 | BPI.calculate(*F, LI); |
| 42 | |
| 43 | // Finally compute BFI. |
| 44 | OwnedBFI = llvm::make_unique<BlockFrequencyInfo>(*F, BPI, LI); |
| 45 | BFI = OwnedBFI.get(); |
| 46 | } |
| 47 | |
Adam Nemet | 6100d16 | 2016-07-20 21:44:22 +0000 | [diff] [blame] | 48 | Optional<uint64_t> OptimizationRemarkEmitter::computeHotness(const Value *V) { |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 49 | if (!BFI) |
| 50 | return None; |
| 51 | |
| 52 | return BFI->getBlockProfileCount(cast<BasicBlock>(V)); |
| 53 | } |
| 54 | |
Adam Nemet | a62b7e1 | 2016-09-27 20:55:07 +0000 | [diff] [blame] | 55 | namespace llvm { |
| 56 | namespace yaml { |
| 57 | |
| 58 | template <> struct MappingTraits<DiagnosticInfoOptimizationBase *> { |
| 59 | static void mapping(IO &io, DiagnosticInfoOptimizationBase *&OptDiag) { |
| 60 | assert(io.outputting() && "input not yet implemented"); |
| 61 | |
Adam Nemet | c507ac9 | 2016-09-27 23:47:03 +0000 | [diff] [blame] | 62 | if (io.mapTag("!Passed", OptDiag->getKind() == DK_OptimizationRemark)) |
| 63 | ; |
| 64 | else if (io.mapTag("!Missed", |
| 65 | OptDiag->getKind() == DK_OptimizationRemarkMissed)) |
| 66 | ; |
| 67 | else if (io.mapTag("!Analysis", |
| 68 | OptDiag->getKind() == DK_OptimizationRemarkAnalysis)) |
Adam Nemet | a62b7e1 | 2016-09-27 20:55:07 +0000 | [diff] [blame] | 69 | ; |
Adam Nemet | 2780ee0 | 2016-10-04 17:05:01 +0000 | [diff] [blame] | 70 | else if (io.mapTag("!AnalysisFPCommute", |
| 71 | OptDiag->getKind() == |
| 72 | DK_OptimizationRemarkAnalysisFPCommute)) |
| 73 | ; |
| 74 | else if (io.mapTag("!AnalysisAliasing", |
| 75 | OptDiag->getKind() == |
| 76 | DK_OptimizationRemarkAnalysisAliasing)) |
| 77 | ; |
Adam Nemet | a62b7e1 | 2016-09-27 20:55:07 +0000 | [diff] [blame] | 78 | else |
| 79 | llvm_unreachable("todo"); |
| 80 | |
| 81 | // These are read-only for now. |
| 82 | DebugLoc DL = OptDiag->getDebugLoc(); |
| 83 | StringRef FN = OptDiag->getFunction().getName(); |
| 84 | |
| 85 | StringRef PassName(OptDiag->PassName); |
| 86 | io.mapRequired("Pass", PassName); |
| 87 | io.mapRequired("Name", OptDiag->RemarkName); |
| 88 | if (!io.outputting() || DL) |
| 89 | io.mapOptional("DebugLoc", DL); |
| 90 | io.mapRequired("Function", FN); |
| 91 | io.mapOptional("Hotness", OptDiag->Hotness); |
| 92 | io.mapOptional("Args", OptDiag->Args); |
| 93 | } |
| 94 | }; |
| 95 | |
| 96 | template <> struct MappingTraits<DebugLoc> { |
| 97 | static void mapping(IO &io, DebugLoc &DL) { |
| 98 | assert(io.outputting() && "input not yet implemented"); |
| 99 | |
| 100 | auto *Scope = cast<DIScope>(DL.getScope()); |
| 101 | StringRef File = Scope->getFilename(); |
| 102 | unsigned Line = DL.getLine(); |
| 103 | unsigned Col = DL.getCol(); |
| 104 | |
| 105 | io.mapRequired("File", File); |
| 106 | io.mapRequired("Line", Line); |
| 107 | io.mapRequired("Column", Col); |
| 108 | } |
| 109 | |
| 110 | static const bool flow = true; |
| 111 | }; |
| 112 | |
Adam Nemet | 0428e93 | 2016-10-04 17:05:04 +0000 | [diff] [blame] | 113 | // Implement this as a mapping for now to get proper quotation for the value. |
| 114 | template <> struct MappingTraits<DiagnosticInfoOptimizationBase::Argument> { |
| 115 | static void mapping(IO &io, DiagnosticInfoOptimizationBase::Argument &A) { |
| 116 | assert(io.outputting() && "input not yet implemented"); |
| 117 | io.mapRequired(A.Key.data(), A.Val); |
Adam Nemet | a62b7e1 | 2016-09-27 20:55:07 +0000 | [diff] [blame] | 118 | } |
Adam Nemet | a62b7e1 | 2016-09-27 20:55:07 +0000 | [diff] [blame] | 119 | }; |
| 120 | |
| 121 | } // end namespace yaml |
| 122 | } // end namespace llvm |
| 123 | |
| 124 | LLVM_YAML_IS_SEQUENCE_VECTOR(DiagnosticInfoOptimizationBase::Argument) |
| 125 | |
| 126 | void OptimizationRemarkEmitter::computeHotness( |
| 127 | DiagnosticInfoOptimizationBase &OptDiag) { |
| 128 | Value *V = OptDiag.getCodeRegion(); |
| 129 | if (V) |
| 130 | OptDiag.setHotness(computeHotness(V)); |
| 131 | } |
| 132 | |
| 133 | void OptimizationRemarkEmitter::emit(DiagnosticInfoOptimizationBase &OptDiag) { |
| 134 | computeHotness(OptDiag); |
| 135 | |
| 136 | yaml::Output *Out = F->getContext().getDiagnosticsOutputFile(); |
Hal Finkel | bdd6735 | 2016-10-04 18:13:45 +0000 | [diff] [blame] | 137 | if (Out) { |
Adam Nemet | a62b7e1 | 2016-09-27 20:55:07 +0000 | [diff] [blame] | 138 | auto *P = &const_cast<DiagnosticInfoOptimizationBase &>(OptDiag); |
| 139 | *Out << P; |
| 140 | } |
| 141 | // FIXME: now that IsVerbose is part of DI, filtering for this will be moved |
| 142 | // from here to clang. |
| 143 | if (!OptDiag.isVerbose() || shouldEmitVerbose()) |
| 144 | F->getContext().diagnose(OptDiag); |
| 145 | } |
| 146 | |
Adam Nemet | 7cfd597 | 2016-07-21 01:07:13 +0000 | [diff] [blame] | 147 | void OptimizationRemarkEmitter::emitOptimizationRemark(const char *PassName, |
| 148 | const DebugLoc &DLoc, |
| 149 | const Value *V, |
| 150 | const Twine &Msg) { |
| 151 | LLVMContext &Ctx = F->getContext(); |
Adam Nemet | 04758ba | 2016-09-27 22:19:23 +0000 | [diff] [blame] | 152 | Ctx.diagnose(OptimizationRemark(PassName, *F, DLoc, Msg, computeHotness(V))); |
Adam Nemet | 7cfd597 | 2016-07-21 01:07:13 +0000 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | void OptimizationRemarkEmitter::emitOptimizationRemark(const char *PassName, |
| 156 | Loop *L, |
| 157 | const Twine &Msg) { |
| 158 | emitOptimizationRemark(PassName, L->getStartLoc(), L->getHeader(), Msg); |
| 159 | } |
| 160 | |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 161 | void OptimizationRemarkEmitter::emitOptimizationRemarkMissed( |
Adam Nemet | 6100d16 | 2016-07-20 21:44:22 +0000 | [diff] [blame] | 162 | const char *PassName, const DebugLoc &DLoc, const Value *V, |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 163 | const Twine &Msg, bool IsVerbose) { |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 164 | LLVMContext &Ctx = F->getContext(); |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 165 | if (!IsVerbose || shouldEmitVerbose()) |
Adam Nemet | 04758ba | 2016-09-27 22:19:23 +0000 | [diff] [blame] | 166 | Ctx.diagnose( |
| 167 | OptimizationRemarkMissed(PassName, *F, DLoc, Msg, computeHotness(V))); |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 168 | } |
| 169 | |
| 170 | void OptimizationRemarkEmitter::emitOptimizationRemarkMissed( |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 171 | const char *PassName, Loop *L, const Twine &Msg, bool IsVerbose) { |
| 172 | emitOptimizationRemarkMissed(PassName, L->getStartLoc(), L->getHeader(), Msg, |
| 173 | IsVerbose); |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 174 | } |
| 175 | |
Adam Nemet | 5b3a5cf | 2016-07-20 21:44:26 +0000 | [diff] [blame] | 176 | void OptimizationRemarkEmitter::emitOptimizationRemarkAnalysis( |
| 177 | const char *PassName, const DebugLoc &DLoc, const Value *V, |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 178 | const Twine &Msg, bool IsVerbose) { |
Adam Nemet | 5b3a5cf | 2016-07-20 21:44:26 +0000 | [diff] [blame] | 179 | LLVMContext &Ctx = F->getContext(); |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 180 | if (!IsVerbose || shouldEmitVerbose()) |
Adam Nemet | 04758ba | 2016-09-27 22:19:23 +0000 | [diff] [blame] | 181 | Ctx.diagnose( |
| 182 | OptimizationRemarkAnalysis(PassName, *F, DLoc, Msg, computeHotness(V))); |
Adam Nemet | 5b3a5cf | 2016-07-20 21:44:26 +0000 | [diff] [blame] | 183 | } |
| 184 | |
| 185 | void OptimizationRemarkEmitter::emitOptimizationRemarkAnalysis( |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 186 | const char *PassName, Loop *L, const Twine &Msg, bool IsVerbose) { |
Adam Nemet | 5b3a5cf | 2016-07-20 21:44:26 +0000 | [diff] [blame] | 187 | emitOptimizationRemarkAnalysis(PassName, L->getStartLoc(), L->getHeader(), |
Adam Nemet | cef3314 | 2016-08-26 20:21:05 +0000 | [diff] [blame] | 188 | Msg, IsVerbose); |
Adam Nemet | 5b3a5cf | 2016-07-20 21:44:26 +0000 | [diff] [blame] | 189 | } |
| 190 | |
Adam Nemet | 0e0e2d5 | 2016-07-20 23:50:32 +0000 | [diff] [blame] | 191 | void OptimizationRemarkEmitter::emitOptimizationRemarkAnalysisFPCommute( |
Adam Nemet | cbe2a9b | 2016-07-21 01:11:12 +0000 | [diff] [blame] | 192 | const char *PassName, const DebugLoc &DLoc, const Value *V, |
| 193 | const Twine &Msg) { |
Adam Nemet | 0e0e2d5 | 2016-07-20 23:50:32 +0000 | [diff] [blame] | 194 | LLVMContext &Ctx = F->getContext(); |
Adam Nemet | 04758ba | 2016-09-27 22:19:23 +0000 | [diff] [blame] | 195 | Ctx.diagnose(OptimizationRemarkAnalysisFPCommute(PassName, *F, DLoc, Msg, |
| 196 | computeHotness(V))); |
Adam Nemet | 0e0e2d5 | 2016-07-20 23:50:32 +0000 | [diff] [blame] | 197 | } |
| 198 | |
| 199 | void OptimizationRemarkEmitter::emitOptimizationRemarkAnalysisAliasing( |
Adam Nemet | cbe2a9b | 2016-07-21 01:11:12 +0000 | [diff] [blame] | 200 | const char *PassName, const DebugLoc &DLoc, const Value *V, |
| 201 | const Twine &Msg) { |
Adam Nemet | 0e0e2d5 | 2016-07-20 23:50:32 +0000 | [diff] [blame] | 202 | LLVMContext &Ctx = F->getContext(); |
Adam Nemet | 04758ba | 2016-09-27 22:19:23 +0000 | [diff] [blame] | 203 | Ctx.diagnose(OptimizationRemarkAnalysisAliasing(PassName, *F, DLoc, Msg, |
| 204 | computeHotness(V))); |
Adam Nemet | 0e0e2d5 | 2016-07-20 23:50:32 +0000 | [diff] [blame] | 205 | } |
| 206 | |
| 207 | void OptimizationRemarkEmitter::emitOptimizationRemarkAnalysisAliasing( |
| 208 | const char *PassName, Loop *L, const Twine &Msg) { |
| 209 | emitOptimizationRemarkAnalysisAliasing(PassName, L->getStartLoc(), |
| 210 | L->getHeader(), Msg); |
| 211 | } |
| 212 | |
Adam Nemet | 79ac42a | 2016-07-18 16:29:21 +0000 | [diff] [blame] | 213 | OptimizationRemarkEmitterWrapperPass::OptimizationRemarkEmitterWrapperPass() |
| 214 | : FunctionPass(ID) { |
| 215 | initializeOptimizationRemarkEmitterWrapperPassPass( |
| 216 | *PassRegistry::getPassRegistry()); |
| 217 | } |
| 218 | |
| 219 | bool OptimizationRemarkEmitterWrapperPass::runOnFunction(Function &Fn) { |
| 220 | BlockFrequencyInfo *BFI; |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 221 | |
| 222 | if (Fn.getContext().getDiagnosticHotnessRequested()) |
| 223 | BFI = &getAnalysis<LazyBlockFrequencyInfoPass>().getBFI(); |
| 224 | else |
| 225 | BFI = nullptr; |
| 226 | |
Adam Nemet | 79ac42a | 2016-07-18 16:29:21 +0000 | [diff] [blame] | 227 | ORE = llvm::make_unique<OptimizationRemarkEmitter>(&Fn, BFI); |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 228 | return false; |
| 229 | } |
| 230 | |
Adam Nemet | 79ac42a | 2016-07-18 16:29:21 +0000 | [diff] [blame] | 231 | void OptimizationRemarkEmitterWrapperPass::getAnalysisUsage( |
| 232 | AnalysisUsage &AU) const { |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 233 | LazyBlockFrequencyInfoPass::getLazyBFIAnalysisUsage(AU); |
| 234 | AU.setPreservesAll(); |
| 235 | } |
| 236 | |
Adam Nemet | 79ac42a | 2016-07-18 16:29:21 +0000 | [diff] [blame] | 237 | char OptimizationRemarkEmitterAnalysis::PassID; |
| 238 | |
| 239 | OptimizationRemarkEmitter |
Adam Nemet | 78d1091 | 2016-07-20 21:44:18 +0000 | [diff] [blame] | 240 | OptimizationRemarkEmitterAnalysis::run(Function &F, |
Sean Silva | 36e0d01 | 2016-08-09 00:28:15 +0000 | [diff] [blame] | 241 | FunctionAnalysisManager &AM) { |
Adam Nemet | 79ac42a | 2016-07-18 16:29:21 +0000 | [diff] [blame] | 242 | BlockFrequencyInfo *BFI; |
| 243 | |
| 244 | if (F.getContext().getDiagnosticHotnessRequested()) |
| 245 | BFI = &AM.getResult<BlockFrequencyAnalysis>(F); |
| 246 | else |
| 247 | BFI = nullptr; |
| 248 | |
| 249 | return OptimizationRemarkEmitter(&F, BFI); |
| 250 | } |
| 251 | |
| 252 | char OptimizationRemarkEmitterWrapperPass::ID = 0; |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 253 | static const char ore_name[] = "Optimization Remark Emitter"; |
| 254 | #define ORE_NAME "opt-remark-emitter" |
| 255 | |
Adam Nemet | 79ac42a | 2016-07-18 16:29:21 +0000 | [diff] [blame] | 256 | INITIALIZE_PASS_BEGIN(OptimizationRemarkEmitterWrapperPass, ORE_NAME, ore_name, |
| 257 | false, true) |
Adam Nemet | aad8160 | 2016-07-15 17:23:20 +0000 | [diff] [blame] | 258 | INITIALIZE_PASS_DEPENDENCY(LazyBFIPass) |
Adam Nemet | 79ac42a | 2016-07-18 16:29:21 +0000 | [diff] [blame] | 259 | INITIALIZE_PASS_END(OptimizationRemarkEmitterWrapperPass, ORE_NAME, ore_name, |
| 260 | false, true) |