LLVM 17.0.0git
AnnotationRemarks.cpp
Go to the documentation of this file.
1//===-- AnnotationRemarks.cpp - Generate remarks for annotated instrs. ----===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// Generate remarks for instructions marked with !annotation.
10//
11//===----------------------------------------------------------------------===//
12
14#include "llvm/ADT/MapVector.h"
17#include "llvm/IR/Function.h"
21
22using namespace llvm;
23using namespace llvm::ore;
24
25#define DEBUG_TYPE "annotation-remarks"
26#define REMARK_PASS DEBUG_TYPE
27
30 const TargetLibraryInfo &TLI) {
31 // For every auto-init annotation generate a separate remark.
32 for (Instruction *I : Instructions) {
34 continue;
35
36 Function &F = *I->getParent()->getParent();
37 const DataLayout &DL = F.getParent()->getDataLayout();
39 Remark.visit(I);
40 }
41}
42
43static void runImpl(Function &F, const TargetLibraryInfo &TLI) {
45 return;
46
47 // Track all annotated instructions aggregated based on their debug location.
49
51 // First, generate a summary of the annotated instructions.
53 for (Instruction &I : instructions(F)) {
54 if (!I.hasMetadata(LLVMContext::MD_annotation))
55 continue;
56 auto Iter = DebugLoc2Annotated.insert({I.getDebugLoc().getAsMDNode(), {}});
57 Iter.first->second.push_back(&I);
58
59 for (const MDOperand &Op :
60 I.getMetadata(LLVMContext::MD_annotation)->operands()) {
61 auto Iter = Mapping.insert({cast<MDString>(Op.get())->getString(), 0});
62 Iter.first->second++;
63 }
64 }
65
66 for (const auto &KV : Mapping)
67 ORE.emit(OptimizationRemarkAnalysis(REMARK_PASS, "AnnotationSummary",
68 F.getSubprogram(), &F.front())
69 << "Annotated " << NV("count", KV.second) << " instructions with "
70 << NV("type", KV.first));
71
72 // For each debug location, look for all the instructions with annotations and
73 // generate more detailed remarks to be displayed at that location.
74 for (auto &KV : DebugLoc2Annotated) {
75 // Don't generate remarks with no debug location.
76 if (!KV.first)
77 continue;
78
79 tryEmitAutoInitRemark(KV.second, ORE, TLI);
80 }
81}
82
85 auto &TLI = AM.getResult<TargetLibraryAnalysis>(F);
86 runImpl(F, TLI);
88}
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
#define REMARK_PASS
static void tryEmitAutoInitRemark(ArrayRef< Instruction * > Instructions, OptimizationRemarkEmitter &ORE, const TargetLibraryInfo &TLI)
static void runImpl(Function &F, const TargetLibraryInfo &TLI)
static bool runImpl(Function &F, const TargetLowering &TLI)
#define F(x, y, z)
Definition: MD5.cpp:55
#define I(x, y, z)
Definition: MD5.cpp:58
This file implements a map that provides insertion order iteration.
print must be executed print the must be executed context for all instructions
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:620
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
Definition: PassManager.h:774
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
A parsed version of the target data layout string in and methods for querying it.
Definition: DataLayout.h:114
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition: DenseMap.h:207
Tracking metadata reference owned by Metadata.
Definition: Metadata.h:772
This class implements a map that also provides access to all stored values in a deterministic order.
Definition: MapVector.h:37
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition: MapVector.h:118
Diagnostic information for optimization analysis remarks.
The optimization diagnostic interface.
bool allowExtraAnalysis(StringRef PassName) const
Whether we allow for extra compile-time budget to perform more analysis to produce fewer false positi...
void emit(DiagnosticInfoOptimizationBase &OptDiag)
Output the remark via the diagnostic handler and to the optimization record file.
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:152
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition: PassManager.h:158
Analysis pass providing the TargetLibraryInfo.
Provides information about what library functions are available for the current target.
Add a small namespace to avoid name clashes with the classes used in the streaming interface.
DiagnosticInfoOptimizationBase::Argument NV
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM)
Special case for -ftrivial-auto-var-init remarks.
static bool canHandle(const Instruction *I)