1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
//===-- MachineFunctionPass.cpp -------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This file contains the definitions of the MachineFunctionPass members.
//
//===----------------------------------------------------------------------===//
#include "llvm/CodeGen/MachineFunctionPass.h"
#include "llvm/Analysis/BasicAliasAnalysis.h"
#include "llvm/Analysis/DominanceFrontier.h"
#include "llvm/Analysis/GlobalsModRef.h"
#include "llvm/Analysis/IVUsers.h"
#include "llvm/Analysis/LoopInfo.h"
#include "llvm/Analysis/MemoryDependenceAnalysis.h"
#include "llvm/Analysis/OptimizationRemarkEmitter.h"
#include "llvm/Analysis/ScalarEvolution.h"
#include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
#include "llvm/CodeGen/MachineFunction.h"
#include "llvm/CodeGen/MachineModuleInfo.h"
#include "llvm/CodeGen/MachineOptimizationRemarkEmitter.h"
#include "llvm/CodeGen/Passes.h"
#include "llvm/IR/Dominators.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/PrintPasses.h"
using namespace llvm;
using namespace ore;
Pass *MachineFunctionPass::createPrinterPass(raw_ostream &O,
const std::string &Banner) const {
return createMachineFunctionPrinterPass(O, Banner);
}
bool MachineFunctionPass::runOnFunction(Function &F) {
// Do not codegen any 'available_externally' functions at all, they have
// definitions outside the translation unit.
if (F.hasAvailableExternallyLinkage())
return false;
MachineModuleInfo &MMI = getAnalysis<MachineModuleInfoWrapperPass>().getMMI();
MachineFunction &MF = MMI.getOrCreateMachineFunction(F);
MachineFunctionProperties &MFProps = MF.getProperties();
#ifndef NDEBUG
if (!MFProps.verifyRequiredProperties(RequiredProperties)) {
errs() << "MachineFunctionProperties required by " << getPassName()
<< " pass are not met by function " << F.getName() << ".\n"
<< "Required properties: ";
RequiredProperties.print(errs());
errs() << "\nCurrent properties: ";
MFProps.print(errs());
errs() << "\n";
llvm_unreachable("MachineFunctionProperties check failed");
}
#endif
// Collect the MI count of the function before the pass.
unsigned CountBefore, CountAfter;
// Check if the user asked for size remarks.
bool ShouldEmitSizeRemarks =
F.getParent()->shouldEmitInstrCountChangedRemark();
// If we want size remarks, collect the number of MachineInstrs in our
// MachineFunction before the pass runs.
if (ShouldEmitSizeRemarks)
CountBefore = MF.getInstructionCount();
// For --print-changed, if the function name is a candidate, save the
// serialized MF to be compared later.
SmallString<0> BeforeStr, AfterStr;
StringRef PassID;
if (PrintChanged != ChangePrinter::None) {
if (const PassInfo *PI = Pass::lookupPassInfo(getPassID()))
PassID = PI->getPassArgument();
}
const bool IsInterestingPass = isPassInPrintList(PassID);
const bool ShouldPrintChanged = PrintChanged != ChangePrinter::None &&
IsInterestingPass &&
isFunctionInPrintList(MF.getName());
if (ShouldPrintChanged) {
raw_svector_ostream OS(BeforeStr);
MF.print(OS);
}
bool RV = runOnMachineFunction(MF);
if (ShouldEmitSizeRemarks) {
// We wanted size remarks. Check if there was a change to the number of
// MachineInstrs in the module. Emit a remark if there was a change.
CountAfter = MF.getInstructionCount();
if (CountBefore != CountAfter) {
MachineOptimizationRemarkEmitter MORE(MF, nullptr);
MORE.emit([&]() {
int64_t Delta = static_cast<int64_t>(CountAfter) -
static_cast<int64_t>(CountBefore);
MachineOptimizationRemarkAnalysis R("size-info", "FunctionMISizeChange",
MF.getFunction().getSubprogram(),
&MF.front());
R << NV("Pass", getPassName())
<< ": Function: " << NV("Function", F.getName()) << ": "
<< "MI Instruction count changed from "
<< NV("MIInstrsBefore", CountBefore) << " to "
<< NV("MIInstrsAfter", CountAfter)
<< "; Delta: " << NV("Delta", Delta);
return R;
});
}
}
MFProps.set(SetProperties);
MFProps.reset(ClearedProperties);
// For --print-changed, print if the serialized MF has changed. Modes other
// than quiet/verbose are unimplemented and treated the same as 'quiet'.
if (ShouldPrintChanged || !IsInterestingPass) {
if (ShouldPrintChanged) {
raw_svector_ostream OS(AfterStr);
MF.print(OS);
}
if (IsInterestingPass && BeforeStr != AfterStr) {
errs() << ("*** IR Dump After " + getPassName() + " (" + PassID +
") on " + MF.getName() + " ***\n");
switch (PrintChanged) {
case ChangePrinter::None:
llvm_unreachable("");
case ChangePrinter::Quiet:
case ChangePrinter::Verbose:
case ChangePrinter::DotCfgQuiet: // unimplemented
case ChangePrinter::DotCfgVerbose: // unimplemented
errs() << AfterStr;
break;
case ChangePrinter::DiffQuiet:
case ChangePrinter::DiffVerbose:
case ChangePrinter::ColourDiffQuiet:
case ChangePrinter::ColourDiffVerbose: {
bool Color = llvm::is_contained(
{ChangePrinter::ColourDiffQuiet, ChangePrinter::ColourDiffVerbose},
PrintChanged.getValue());
StringRef Removed = Color ? "\033[31m-%l\033[0m\n" : "-%l\n";
StringRef Added = Color ? "\033[32m+%l\033[0m\n" : "+%l\n";
StringRef NoChange = " %l\n";
errs() << doSystemDiff(BeforeStr, AfterStr, Removed, Added, NoChange);
break;
}
}
} else if (llvm::is_contained({ChangePrinter::Verbose,
ChangePrinter::DiffVerbose,
ChangePrinter::ColourDiffVerbose},
PrintChanged.getValue())) {
const char *Reason =
IsInterestingPass ? " omitted because no change" : " filtered out";
errs() << "*** IR Dump After " << getPassName();
if (!PassID.empty())
errs() << " (" << PassID << ")";
errs() << " on " << MF.getName() + Reason + " ***\n";
}
}
return RV;
}
void MachineFunctionPass::getAnalysisUsage(AnalysisUsage &AU) const {
AU.addRequired<MachineModuleInfoWrapperPass>();
AU.addPreserved<MachineModuleInfoWrapperPass>();
// MachineFunctionPass preserves all LLVM IR passes, but there's no
// high-level way to express this. Instead, just list a bunch of
// passes explicitly. This does not include setPreservesCFG,
// because CodeGen overloads that to mean preserving the MachineBasicBlock
// CFG in addition to the LLVM IR CFG.
AU.addPreserved<BasicAAWrapperPass>();
AU.addPreserved<DominanceFrontierWrapperPass>();
AU.addPreserved<DominatorTreeWrapperPass>();
AU.addPreserved<AAResultsWrapperPass>();
AU.addPreserved<GlobalsAAWrapperPass>();
AU.addPreserved<IVUsersWrapperPass>();
AU.addPreserved<LoopInfoWrapperPass>();
AU.addPreserved<MemoryDependenceWrapperPass>();
AU.addPreserved<ScalarEvolutionWrapperPass>();
AU.addPreserved<SCEVAAWrapperPass>();
FunctionPass::getAnalysisUsage(AU);
}
|
