blob: d26e796bb544d838db6e3837ca8b2f40ed4b9009 [file] [log] [blame]
Chandler Carruth1ff77242015-03-07 09:02:36 +00001//===- Parsing, selection, and construction of pass pipelines -------------===//
Chandler Carruth66445382014-01-11 08:16:35 +00002//
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///
Chandler Carruth1ff77242015-03-07 09:02:36 +000011/// This file provides the implementation of the PassBuilder based on our
12/// static pass registry as well as related functionality. It also provides
13/// helpers to aid in analyzing, debugging, and testing passes and pass
14/// pipelines.
Chandler Carruth66445382014-01-11 08:16:35 +000015///
16//===----------------------------------------------------------------------===//
17
Chandler Carruth1ff77242015-03-07 09:02:36 +000018#include "llvm/Passes/PassBuilder.h"
Chandler Carruth8b5a74192016-02-28 22:16:03 +000019#include "llvm/ADT/StringSwitch.h"
Chandler Carruth6f5770b102016-02-13 23:32:00 +000020#include "llvm/Analysis/AliasAnalysis.h"
Chandler Carruth4f846a52016-02-20 03:46:03 +000021#include "llvm/Analysis/AliasAnalysisEvaluator.h"
Chandler Carruthdf8b2232015-01-22 21:53:09 +000022#include "llvm/Analysis/AssumptionCache.h"
Chandler Carruthbece8d52016-02-13 23:46:24 +000023#include "llvm/Analysis/BasicAliasAnalysis.h"
Xinliang David Li6e5dd412016-05-05 02:59:57 +000024#include "llvm/Analysis/BranchProbabilityInfo.h"
Chandler Carruth342c6712016-02-20 03:52:02 +000025#include "llvm/Analysis/CFLAliasAnalysis.h"
Chandler Carruth572e3402014-04-21 11:12:00 +000026#include "llvm/Analysis/CGSCCPassManager.h"
Chandler Carruth4c660f72016-03-10 11:24:11 +000027#include "llvm/Analysis/CallGraph.h"
Michael Kupersteinde16b442016-04-18 23:55:01 +000028#include "llvm/Analysis/DemandedBits.h"
Hongbin Zheng751337f2016-02-25 17:54:15 +000029#include "llvm/Analysis/DominanceFrontier.h"
Chandler Carruth45a9c202016-03-11 09:15:11 +000030#include "llvm/Analysis/GlobalsModRef.h"
Chandler Carruthbf71a342014-02-06 04:37:03 +000031#include "llvm/Analysis/LazyCallGraph.h"
Chandler Carruthaaf0b4c2015-01-20 10:58:50 +000032#include "llvm/Analysis/LoopInfo.h"
Chandler Carruth61440d22016-03-10 00:55:30 +000033#include "llvm/Analysis/MemoryDependenceAnalysis.h"
Hongbin Zheng3f978402016-02-25 17:54:07 +000034#include "llvm/Analysis/PostDominators.h"
Hongbin Zhengbc539772016-02-25 17:54:25 +000035#include "llvm/Analysis/RegionInfo.h"
Chandler Carruth2f1fd162015-08-17 02:08:17 +000036#include "llvm/Analysis/ScalarEvolution.h"
Chandler Carruth2b3d0442016-02-20 04:01:45 +000037#include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
Chandler Carruthd6091a02016-02-20 04:03:06 +000038#include "llvm/Analysis/ScopedNoAliasAA.h"
Chandler Carruth8ca43222015-01-15 11:39:46 +000039#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruthe0385522015-02-01 10:11:22 +000040#include "llvm/Analysis/TargetTransformInfo.h"
Chandler Carruthc1dc3842016-02-20 04:04:52 +000041#include "llvm/Analysis/TypeBasedAliasAnalysis.h"
Chandler Carruth64764b42015-01-14 10:19:28 +000042#include "llvm/IR/Dominators.h"
Chandler Carruth52eef882014-01-12 12:15:39 +000043#include "llvm/IR/IRPrintingPasses.h"
Chandler Carruth66445382014-01-11 08:16:35 +000044#include "llvm/IR/PassManager.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000045#include "llvm/IR/Verifier.h"
Chandler Carruth52eef882014-01-12 12:15:39 +000046#include "llvm/Support/Debug.h"
Chandler Carruth8b5a74192016-02-28 22:16:03 +000047#include "llvm/Support/Regex.h"
Chandler Carruthe0385522015-02-01 10:11:22 +000048#include "llvm/Target/TargetMachine.h"
Davide Italiano164b9bc2016-05-05 00:51:09 +000049#include "llvm/Transforms/IPO/ConstantMerge.h"
Davide Italiano344e8382016-05-05 02:37:32 +000050#include "llvm/Transforms/IPO/ElimAvailExtern.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000051#include "llvm/Transforms/IPO/ForceFunctionAttrs.h"
Chandler Carruth9c4ed172016-02-18 11:03:11 +000052#include "llvm/Transforms/IPO/FunctionAttrs.h"
Davide Italiano66228c42016-05-03 19:39:15 +000053#include "llvm/Transforms/IPO/GlobalDCE.h"
Justin Bogner1a075012016-04-26 00:28:01 +000054#include "llvm/Transforms/IPO/GlobalOpt.h"
Chandler Carruth3a040e62015-12-27 08:41:34 +000055#include "llvm/Transforms/IPO/InferFunctionAttrs.h"
Justin Bogner4563a062016-04-26 20:15:52 +000056#include "llvm/Transforms/IPO/Internalize.h"
Davide Italianof54f2f02016-05-05 21:05:36 +000057#include "llvm/Transforms/IPO/SCCP.h"
Justin Bogner21e15372015-10-30 23:28:12 +000058#include "llvm/Transforms/IPO/StripDeadPrototypes.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000059#include "llvm/Transforms/InstCombine/InstCombine.h"
Xinliang David Lie6b89292016-04-18 17:47:38 +000060#include "llvm/Transforms/InstrProfiling.h"
Justin Bogner19b67992015-10-30 23:13:18 +000061#include "llvm/Transforms/Scalar/ADCE.h"
Justin Bogner395c2122016-04-22 19:40:41 +000062#include "llvm/Transforms/Scalar/DCE.h"
Chandler Carruthe8c686a2015-02-01 10:51:23 +000063#include "llvm/Transforms/Scalar/EarlyCSE.h"
Davide Italiano164b9bc2016-05-05 00:51:09 +000064#include "llvm/Transforms/Scalar/GVN.h"
Justin Bognerd0d23412016-05-03 22:02:31 +000065#include "llvm/Transforms/Scalar/LoopRotation.h"
Justin Bognerab6a5132016-05-03 21:47:32 +000066#include "llvm/Transforms/Scalar/LoopSimplifyCFG.h"
Chandler Carruth43e590e2015-01-24 11:13:02 +000067#include "llvm/Transforms/Scalar/LowerExpectIntrinsic.h"
Justin Bognerc2bf63d2016-04-26 23:39:29 +000068#include "llvm/Transforms/Scalar/Reassociate.h"
Chandler Carruth29a18a42015-09-12 09:09:14 +000069#include "llvm/Transforms/Scalar/SROA.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000070#include "llvm/Transforms/Scalar/SimplifyCFG.h"
Justin Bognerb9394902016-04-22 19:54:10 +000071#include "llvm/Transforms/Scalar/Sink.h"
Chandler Carruth58dde8c2016-02-26 12:17:54 +000072#include <type_traits>
Chandler Carruth66445382014-01-11 08:16:35 +000073
74using namespace llvm;
75
Chandler Carruth8b5a74192016-02-28 22:16:03 +000076static Regex DefaultAliasRegex("^(default|lto-pre-link|lto)<(O[0123sz])>$");
77
Chandler Carruth66445382014-01-11 08:16:35 +000078namespace {
79
Chandler Carruthd8330982014-01-12 09:34:22 +000080/// \brief No-op module pass which does nothing.
Chandler Carruth66445382014-01-11 08:16:35 +000081struct NoOpModulePass {
Chandler Carruthd174ce42015-01-05 02:47:05 +000082 PreservedAnalyses run(Module &M) { return PreservedAnalyses::all(); }
Chandler Carrutha13f27c2014-01-11 11:52:05 +000083 static StringRef name() { return "NoOpModulePass"; }
Chandler Carruth66445382014-01-11 08:16:35 +000084};
85
Chandler Carruth0b576b32015-01-06 02:50:06 +000086/// \brief No-op module analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +000087class NoOpModuleAnalysis : public AnalysisInfoMixin<NoOpModuleAnalysis> {
88 friend AnalysisInfoMixin<NoOpModuleAnalysis>;
Chandler Carruthb4faf132016-03-11 10:22:49 +000089 static char PassID;
90
91public:
Chandler Carruth0b576b32015-01-06 02:50:06 +000092 struct Result {};
93 Result run(Module &) { return Result(); }
94 static StringRef name() { return "NoOpModuleAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +000095};
96
Chandler Carruth572e3402014-04-21 11:12:00 +000097/// \brief No-op CGSCC pass which does nothing.
98struct NoOpCGSCCPass {
Chandler Carruthd174ce42015-01-05 02:47:05 +000099 PreservedAnalyses run(LazyCallGraph::SCC &C) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000100 return PreservedAnalyses::all();
101 }
102 static StringRef name() { return "NoOpCGSCCPass"; }
103};
104
Chandler Carruth0b576b32015-01-06 02:50:06 +0000105/// \brief No-op CGSCC analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000106class NoOpCGSCCAnalysis : public AnalysisInfoMixin<NoOpCGSCCAnalysis> {
107 friend AnalysisInfoMixin<NoOpCGSCCAnalysis>;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000108 static char PassID;
109
110public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000111 struct Result {};
112 Result run(LazyCallGraph::SCC &) { return Result(); }
113 static StringRef name() { return "NoOpCGSCCAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000114};
115
Chandler Carruthd8330982014-01-12 09:34:22 +0000116/// \brief No-op function pass which does nothing.
117struct NoOpFunctionPass {
Chandler Carruthd174ce42015-01-05 02:47:05 +0000118 PreservedAnalyses run(Function &F) { return PreservedAnalyses::all(); }
Chandler Carruthd8330982014-01-12 09:34:22 +0000119 static StringRef name() { return "NoOpFunctionPass"; }
120};
121
Chandler Carruth0b576b32015-01-06 02:50:06 +0000122/// \brief No-op function analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000123class NoOpFunctionAnalysis : public AnalysisInfoMixin<NoOpFunctionAnalysis> {
124 friend AnalysisInfoMixin<NoOpFunctionAnalysis>;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000125 static char PassID;
126
127public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000128 struct Result {};
129 Result run(Function &) { return Result(); }
130 static StringRef name() { return "NoOpFunctionAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000131};
132
Justin Bognereecc3c82016-02-25 07:23:08 +0000133/// \brief No-op loop pass which does nothing.
134struct NoOpLoopPass {
135 PreservedAnalyses run(Loop &L) { return PreservedAnalyses::all(); }
136 static StringRef name() { return "NoOpLoopPass"; }
137};
138
139/// \brief No-op loop analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000140class NoOpLoopAnalysis : public AnalysisInfoMixin<NoOpLoopAnalysis> {
141 friend AnalysisInfoMixin<NoOpLoopAnalysis>;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000142 static char PassID;
143
144public:
Justin Bognereecc3c82016-02-25 07:23:08 +0000145 struct Result {};
146 Result run(Loop &) { return Result(); }
147 static StringRef name() { return "NoOpLoopAnalysis"; }
Justin Bognereecc3c82016-02-25 07:23:08 +0000148};
149
Chandler Carruthb4faf132016-03-11 10:22:49 +0000150char NoOpModuleAnalysis::PassID;
151char NoOpCGSCCAnalysis::PassID;
152char NoOpFunctionAnalysis::PassID;
153char NoOpLoopAnalysis::PassID;
154
Chandler Carruth66445382014-01-11 08:16:35 +0000155} // End anonymous namespace.
156
Chandler Carruth1ff77242015-03-07 09:02:36 +0000157void PassBuilder::registerModuleAnalyses(ModuleAnalysisManager &MAM) {
Chandler Carruthb70f6732015-01-06 02:21:37 +0000158#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000159 MAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000160#include "PassRegistry.def"
161}
162
Chandler Carruth1ff77242015-03-07 09:02:36 +0000163void PassBuilder::registerCGSCCAnalyses(CGSCCAnalysisManager &CGAM) {
Chandler Carruthb70f6732015-01-06 02:21:37 +0000164#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000165 CGAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000166#include "PassRegistry.def"
167}
168
Chandler Carruth1ff77242015-03-07 09:02:36 +0000169void PassBuilder::registerFunctionAnalyses(FunctionAnalysisManager &FAM) {
Chandler Carruthb70f6732015-01-06 02:21:37 +0000170#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000171 FAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000172#include "PassRegistry.def"
173}
174
Justin Bognereecc3c82016-02-25 07:23:08 +0000175void PassBuilder::registerLoopAnalyses(LoopAnalysisManager &LAM) {
176#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
177 LAM.registerPass([&] { return CREATE_PASS; });
178#include "PassRegistry.def"
179}
180
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000181void PassBuilder::addPerModuleDefaultPipeline(ModulePassManager &MPM,
182 OptimizationLevel Level,
183 bool DebugLogging) {
184 // FIXME: Finish fleshing this out to match the legacy pipelines.
185 FunctionPassManager EarlyFPM(DebugLogging);
186 EarlyFPM.addPass(SimplifyCFGPass());
187 EarlyFPM.addPass(SROA());
188 EarlyFPM.addPass(EarlyCSEPass());
189 EarlyFPM.addPass(LowerExpectIntrinsicPass());
190
191 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(EarlyFPM)));
192}
193
194void PassBuilder::addLTOPreLinkDefaultPipeline(ModulePassManager &MPM,
195 OptimizationLevel Level,
196 bool DebugLogging) {
197 // FIXME: We should use a customized pre-link pipeline!
198 addPerModuleDefaultPipeline(MPM, Level, DebugLogging);
199}
200
201void PassBuilder::addLTODefaultPipeline(ModulePassManager &MPM,
202 OptimizationLevel Level,
203 bool DebugLogging) {
204 // FIXME: Finish fleshing this out to match the legacy LTO pipelines.
205 FunctionPassManager LateFPM(DebugLogging);
206 LateFPM.addPass(InstCombinePass());
207 LateFPM.addPass(SimplifyCFGPass());
208
209 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(LateFPM)));
210}
211
Chandler Carruth9d2e58f2015-01-06 09:10:47 +0000212#ifndef NDEBUG
Chandler Carruth66445382014-01-11 08:16:35 +0000213static bool isModulePassName(StringRef Name) {
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000214 // Manually handle aliases for pre-configured pipeline fragments.
215 if (Name.startswith("default") || Name.startswith("lto"))
216 return DefaultAliasRegex.match(Name);
217
Chandler Carruth58944182014-04-21 08:08:50 +0000218#define MODULE_PASS(NAME, CREATE_PASS) if (Name == NAME) return true;
Chandler Carruth628503e2015-01-06 02:10:51 +0000219#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000220 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +0000221 return true;
222#include "PassRegistry.def"
223
Chandler Carruth66445382014-01-11 08:16:35 +0000224 return false;
225}
Chandler Carruth9d2e58f2015-01-06 09:10:47 +0000226#endif
Chandler Carruth66445382014-01-11 08:16:35 +0000227
Chandler Carruth572e3402014-04-21 11:12:00 +0000228static bool isCGSCCPassName(StringRef Name) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000229#define CGSCC_PASS(NAME, CREATE_PASS) if (Name == NAME) return true;
Chandler Carruth628503e2015-01-06 02:10:51 +0000230#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000231 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +0000232 return true;
233#include "PassRegistry.def"
234
Chandler Carruth572e3402014-04-21 11:12:00 +0000235 return false;
236}
237
Chandler Carruthd8330982014-01-12 09:34:22 +0000238static bool isFunctionPassName(StringRef Name) {
Chandler Carruth58944182014-04-21 08:08:50 +0000239#define FUNCTION_PASS(NAME, CREATE_PASS) if (Name == NAME) return true;
Chandler Carruth628503e2015-01-06 02:10:51 +0000240#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000241 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +0000242 return true;
243#include "PassRegistry.def"
244
Chandler Carruthd8330982014-01-12 09:34:22 +0000245 return false;
246}
247
Justin Bognereecc3c82016-02-25 07:23:08 +0000248static bool isLoopPassName(StringRef Name) {
249#define LOOP_PASS(NAME, CREATE_PASS) if (Name == NAME) return true;
250#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
251 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
252 return true;
253#include "PassRegistry.def"
254
255 return false;
256}
257
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000258bool PassBuilder::parseModulePassName(ModulePassManager &MPM, StringRef Name,
259 bool DebugLogging) {
260 // Manually handle aliases for pre-configured pipeline fragments.
261 if (Name.startswith("default") || Name.startswith("lto")) {
262 SmallVector<StringRef, 3> Matches;
263 if (!DefaultAliasRegex.match(Name, &Matches))
264 return false;
265 assert(Matches.size() == 3 && "Must capture two matched strings!");
266
267 auto L = StringSwitch<OptimizationLevel>(Matches[2])
268 .Case("O0", O0)
269 .Case("O1", O1)
270 .Case("O2", O2)
271 .Case("O3", O3)
272 .Case("Os", Os)
273 .Case("Oz", Oz);
274
275 if (Matches[1] == "default") {
276 addPerModuleDefaultPipeline(MPM, L, DebugLogging);
277 } else if (Matches[1] == "lto-pre-link") {
278 addLTOPreLinkDefaultPipeline(MPM, L, DebugLogging);
279 } else {
280 assert(Matches[1] == "lto" && "Not one of the matched options!");
281 addLTODefaultPipeline(MPM, L, DebugLogging);
282 }
283 return true;
284 }
285
Chandler Carruth58944182014-04-21 08:08:50 +0000286#define MODULE_PASS(NAME, CREATE_PASS) \
287 if (Name == NAME) { \
288 MPM.addPass(CREATE_PASS); \
289 return true; \
Chandler Carruth52eef882014-01-12 12:15:39 +0000290 }
Chandler Carruth628503e2015-01-06 02:10:51 +0000291#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
292 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000293 MPM.addPass(RequireAnalysisPass< \
294 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +0000295 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000296 } \
297 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000298 MPM.addPass(InvalidateAnalysisPass< \
299 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000300 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +0000301 }
302#include "PassRegistry.def"
303
Chandler Carruth66445382014-01-11 08:16:35 +0000304 return false;
305}
306
Chandler Carruth1ff77242015-03-07 09:02:36 +0000307bool PassBuilder::parseCGSCCPassName(CGSCCPassManager &CGPM, StringRef Name) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000308#define CGSCC_PASS(NAME, CREATE_PASS) \
309 if (Name == NAME) { \
310 CGPM.addPass(CREATE_PASS); \
311 return true; \
312 }
Chandler Carruth628503e2015-01-06 02:10:51 +0000313#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
314 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000315 CGPM.addPass(RequireAnalysisPass< \
316 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +0000317 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000318 } \
319 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000320 CGPM.addPass(InvalidateAnalysisPass< \
321 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000322 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +0000323 }
324#include "PassRegistry.def"
325
Chandler Carruth572e3402014-04-21 11:12:00 +0000326 return false;
327}
328
Chandler Carruth1ff77242015-03-07 09:02:36 +0000329bool PassBuilder::parseFunctionPassName(FunctionPassManager &FPM,
330 StringRef Name) {
Chandler Carruth58944182014-04-21 08:08:50 +0000331#define FUNCTION_PASS(NAME, CREATE_PASS) \
332 if (Name == NAME) { \
333 FPM.addPass(CREATE_PASS); \
334 return true; \
Chandler Carruth52eef882014-01-12 12:15:39 +0000335 }
Chandler Carruth628503e2015-01-06 02:10:51 +0000336#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
337 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000338 FPM.addPass(RequireAnalysisPass< \
339 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +0000340 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000341 } \
342 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000343 FPM.addPass(InvalidateAnalysisPass< \
344 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000345 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +0000346 }
347#include "PassRegistry.def"
348
Chandler Carruthd8330982014-01-12 09:34:22 +0000349 return false;
350}
351
Justin Bognereecc3c82016-02-25 07:23:08 +0000352bool PassBuilder::parseLoopPassName(LoopPassManager &FPM,
353 StringRef Name) {
354#define LOOP_PASS(NAME, CREATE_PASS) \
355 if (Name == NAME) { \
356 FPM.addPass(CREATE_PASS); \
357 return true; \
358 }
359#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
360 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000361 FPM.addPass(RequireAnalysisPass< \
362 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Justin Bognereecc3c82016-02-25 07:23:08 +0000363 return true; \
364 } \
365 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000366 FPM.addPass(InvalidateAnalysisPass< \
367 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Justin Bognereecc3c82016-02-25 07:23:08 +0000368 return true; \
369 }
370#include "PassRegistry.def"
371
372 return false;
373}
374
Chandler Carruthedf59962016-02-18 09:45:17 +0000375bool PassBuilder::parseAAPassName(AAManager &AA, StringRef Name) {
Chandler Carruth45a9c202016-03-11 09:15:11 +0000376#define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
377 if (Name == NAME) { \
378 AA.registerModuleAnalysis< \
379 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
380 return true; \
381 }
Chandler Carruthedf59962016-02-18 09:45:17 +0000382#define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
383 if (Name == NAME) { \
Chandler Carruth58dde8c2016-02-26 12:17:54 +0000384 AA.registerFunctionAnalysis< \
385 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
Chandler Carruthedf59962016-02-18 09:45:17 +0000386 return true; \
387 }
388#include "PassRegistry.def"
389
390 return false;
391}
392
Justin Bognereecc3c82016-02-25 07:23:08 +0000393bool PassBuilder::parseLoopPassPipeline(LoopPassManager &LPM,
394 StringRef &PipelineText,
395 bool VerifyEachPass,
396 bool DebugLogging) {
397 for (;;) {
398 // Parse nested pass managers by recursing.
399 if (PipelineText.startswith("loop(")) {
400 LoopPassManager NestedLPM(DebugLogging);
401
402 // Parse the inner pipeline inte the nested manager.
403 PipelineText = PipelineText.substr(strlen("loop("));
404 if (!parseLoopPassPipeline(NestedLPM, PipelineText, VerifyEachPass,
405 DebugLogging) ||
406 PipelineText.empty())
407 return false;
408 assert(PipelineText[0] == ')');
409 PipelineText = PipelineText.substr(1);
410
411 // Add the nested pass manager with the appropriate adaptor.
412 LPM.addPass(std::move(NestedLPM));
413 } else {
414 // Otherwise try to parse a pass name.
415 size_t End = PipelineText.find_first_of(",)");
416 if (!parseLoopPassName(LPM, PipelineText.substr(0, End)))
417 return false;
418 // TODO: Ideally, we would run a LoopVerifierPass() here in the
419 // VerifyEachPass case, but we don't have such a verifier yet.
420
421 PipelineText = PipelineText.substr(End);
422 }
423
424 if (PipelineText.empty() || PipelineText[0] == ')')
425 return true;
426
427 assert(PipelineText[0] == ',');
428 PipelineText = PipelineText.substr(1);
429 }
430}
431
Chandler Carruth1ff77242015-03-07 09:02:36 +0000432bool PassBuilder::parseFunctionPassPipeline(FunctionPassManager &FPM,
433 StringRef &PipelineText,
434 bool VerifyEachPass,
435 bool DebugLogging) {
Chandler Carruthd8330982014-01-12 09:34:22 +0000436 for (;;) {
437 // Parse nested pass managers by recursing.
438 if (PipelineText.startswith("function(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000439 FunctionPassManager NestedFPM(DebugLogging);
Chandler Carruthd8330982014-01-12 09:34:22 +0000440
441 // Parse the inner pipeline inte the nested manager.
442 PipelineText = PipelineText.substr(strlen("function("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000443 if (!parseFunctionPassPipeline(NestedFPM, PipelineText, VerifyEachPass,
444 DebugLogging) ||
Chandler Carruth6546cb62014-01-12 10:02:02 +0000445 PipelineText.empty())
Chandler Carruthd8330982014-01-12 09:34:22 +0000446 return false;
Chandler Carruth6546cb62014-01-12 10:02:02 +0000447 assert(PipelineText[0] == ')');
Chandler Carruthd8330982014-01-12 09:34:22 +0000448 PipelineText = PipelineText.substr(1);
449
450 // Add the nested pass manager with the appropriate adaptor.
Chandler Carruthc3f3da32014-03-09 11:49:53 +0000451 FPM.addPass(std::move(NestedFPM));
Justin Bognereecc3c82016-02-25 07:23:08 +0000452 } else if (PipelineText.startswith("loop(")) {
453 LoopPassManager NestedLPM(DebugLogging);
454
455 // Parse the inner pipeline inte the nested manager.
456 PipelineText = PipelineText.substr(strlen("loop("));
457 if (!parseLoopPassPipeline(NestedLPM, PipelineText, VerifyEachPass,
458 DebugLogging) ||
459 PipelineText.empty())
460 return false;
461 assert(PipelineText[0] == ')');
462 PipelineText = PipelineText.substr(1);
463
464 // Add the nested pass manager with the appropriate adaptor.
465 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(NestedLPM)));
Chandler Carruthd8330982014-01-12 09:34:22 +0000466 } else {
467 // Otherwise try to parse a pass name.
468 size_t End = PipelineText.find_first_of(",)");
469 if (!parseFunctionPassName(FPM, PipelineText.substr(0, End)))
470 return false;
Chandler Carruth4d356312014-01-20 11:34:08 +0000471 if (VerifyEachPass)
472 FPM.addPass(VerifierPass());
Chandler Carruthd8330982014-01-12 09:34:22 +0000473
474 PipelineText = PipelineText.substr(End);
475 }
476
477 if (PipelineText.empty() || PipelineText[0] == ')')
478 return true;
479
480 assert(PipelineText[0] == ',');
481 PipelineText = PipelineText.substr(1);
482 }
483}
484
Chandler Carruth1ff77242015-03-07 09:02:36 +0000485bool PassBuilder::parseCGSCCPassPipeline(CGSCCPassManager &CGPM,
486 StringRef &PipelineText,
487 bool VerifyEachPass,
488 bool DebugLogging) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000489 for (;;) {
490 // Parse nested pass managers by recursing.
491 if (PipelineText.startswith("cgscc(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000492 CGSCCPassManager NestedCGPM(DebugLogging);
Chandler Carruth572e3402014-04-21 11:12:00 +0000493
494 // Parse the inner pipeline into the nested manager.
495 PipelineText = PipelineText.substr(strlen("cgscc("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000496 if (!parseCGSCCPassPipeline(NestedCGPM, PipelineText, VerifyEachPass,
497 DebugLogging) ||
Chandler Carruth572e3402014-04-21 11:12:00 +0000498 PipelineText.empty())
499 return false;
500 assert(PipelineText[0] == ')');
501 PipelineText = PipelineText.substr(1);
502
503 // Add the nested pass manager with the appropriate adaptor.
504 CGPM.addPass(std::move(NestedCGPM));
505 } else if (PipelineText.startswith("function(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000506 FunctionPassManager NestedFPM(DebugLogging);
Chandler Carruth572e3402014-04-21 11:12:00 +0000507
508 // Parse the inner pipeline inte the nested manager.
509 PipelineText = PipelineText.substr(strlen("function("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000510 if (!parseFunctionPassPipeline(NestedFPM, PipelineText, VerifyEachPass,
511 DebugLogging) ||
Chandler Carruth572e3402014-04-21 11:12:00 +0000512 PipelineText.empty())
513 return false;
514 assert(PipelineText[0] == ')');
515 PipelineText = PipelineText.substr(1);
516
517 // Add the nested pass manager with the appropriate adaptor.
518 CGPM.addPass(createCGSCCToFunctionPassAdaptor(std::move(NestedFPM)));
519 } else {
520 // Otherwise try to parse a pass name.
521 size_t End = PipelineText.find_first_of(",)");
522 if (!parseCGSCCPassName(CGPM, PipelineText.substr(0, End)))
523 return false;
524 // FIXME: No verifier support for CGSCC passes!
525
526 PipelineText = PipelineText.substr(End);
527 }
528
529 if (PipelineText.empty() || PipelineText[0] == ')')
530 return true;
531
532 assert(PipelineText[0] == ',');
533 PipelineText = PipelineText.substr(1);
534 }
535}
536
Chandler Carruth1ff77242015-03-07 09:02:36 +0000537bool PassBuilder::parseModulePassPipeline(ModulePassManager &MPM,
538 StringRef &PipelineText,
539 bool VerifyEachPass,
540 bool DebugLogging) {
Chandler Carruth66445382014-01-11 08:16:35 +0000541 for (;;) {
542 // Parse nested pass managers by recursing.
543 if (PipelineText.startswith("module(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000544 ModulePassManager NestedMPM(DebugLogging);
Chandler Carruth258dbb32014-01-11 12:06:47 +0000545
546 // Parse the inner pipeline into the nested manager.
Chandler Carruth66445382014-01-11 08:16:35 +0000547 PipelineText = PipelineText.substr(strlen("module("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000548 if (!parseModulePassPipeline(NestedMPM, PipelineText, VerifyEachPass,
549 DebugLogging) ||
Chandler Carruth6546cb62014-01-12 10:02:02 +0000550 PipelineText.empty())
Chandler Carruth66445382014-01-11 08:16:35 +0000551 return false;
Chandler Carruth6546cb62014-01-12 10:02:02 +0000552 assert(PipelineText[0] == ')');
Chandler Carruth66445382014-01-11 08:16:35 +0000553 PipelineText = PipelineText.substr(1);
Chandler Carruth258dbb32014-01-11 12:06:47 +0000554
555 // Now add the nested manager as a module pass.
Chandler Carruthc3f3da32014-03-09 11:49:53 +0000556 MPM.addPass(std::move(NestedMPM));
Chandler Carruth572e3402014-04-21 11:12:00 +0000557 } else if (PipelineText.startswith("cgscc(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000558 CGSCCPassManager NestedCGPM(DebugLogging);
Chandler Carruth572e3402014-04-21 11:12:00 +0000559
560 // Parse the inner pipeline inte the nested manager.
561 PipelineText = PipelineText.substr(strlen("cgscc("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000562 if (!parseCGSCCPassPipeline(NestedCGPM, PipelineText, VerifyEachPass,
563 DebugLogging) ||
Chandler Carruth572e3402014-04-21 11:12:00 +0000564 PipelineText.empty())
565 return false;
566 assert(PipelineText[0] == ')');
567 PipelineText = PipelineText.substr(1);
568
569 // Add the nested pass manager with the appropriate adaptor.
570 MPM.addPass(
571 createModuleToPostOrderCGSCCPassAdaptor(std::move(NestedCGPM)));
Chandler Carruthd8330982014-01-12 09:34:22 +0000572 } else if (PipelineText.startswith("function(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000573 FunctionPassManager NestedFPM(DebugLogging);
Chandler Carruthd8330982014-01-12 09:34:22 +0000574
575 // Parse the inner pipeline inte the nested manager.
576 PipelineText = PipelineText.substr(strlen("function("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000577 if (!parseFunctionPassPipeline(NestedFPM, PipelineText, VerifyEachPass,
578 DebugLogging) ||
Chandler Carruth6546cb62014-01-12 10:02:02 +0000579 PipelineText.empty())
Chandler Carruthd8330982014-01-12 09:34:22 +0000580 return false;
Chandler Carruth6546cb62014-01-12 10:02:02 +0000581 assert(PipelineText[0] == ')');
Chandler Carruthd8330982014-01-12 09:34:22 +0000582 PipelineText = PipelineText.substr(1);
583
584 // Add the nested pass manager with the appropriate adaptor.
Chandler Carruthc3f3da32014-03-09 11:49:53 +0000585 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(NestedFPM)));
Chandler Carruth66445382014-01-11 08:16:35 +0000586 } else {
587 // Otherwise try to parse a pass name.
588 size_t End = PipelineText.find_first_of(",)");
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000589 if (!parseModulePassName(MPM, PipelineText.substr(0, End), DebugLogging))
Chandler Carruth66445382014-01-11 08:16:35 +0000590 return false;
Chandler Carruth4d356312014-01-20 11:34:08 +0000591 if (VerifyEachPass)
592 MPM.addPass(VerifierPass());
Chandler Carruth66445382014-01-11 08:16:35 +0000593
594 PipelineText = PipelineText.substr(End);
595 }
596
597 if (PipelineText.empty() || PipelineText[0] == ')')
598 return true;
599
600 assert(PipelineText[0] == ',');
601 PipelineText = PipelineText.substr(1);
602 }
603}
604
605// Primary pass pipeline description parsing routine.
606// FIXME: Should this routine accept a TargetMachine or require the caller to
607// pre-populate the analysis managers with target-specific stuff?
Chandler Carruth1ff77242015-03-07 09:02:36 +0000608bool PassBuilder::parsePassPipeline(ModulePassManager &MPM,
609 StringRef PipelineText, bool VerifyEachPass,
610 bool DebugLogging) {
Chandler Carruthea368f12015-01-06 08:37:58 +0000611 // By default, try to parse the pipeline as-if it were within an implicit
612 // 'module(...)' pass pipeline. If this will parse at all, it needs to
613 // consume the entire string.
Chandler Carruth14a759e2015-01-13 22:42:38 +0000614 if (parseModulePassPipeline(MPM, PipelineText, VerifyEachPass, DebugLogging))
Chandler Carruthea368f12015-01-06 08:37:58 +0000615 return PipelineText.empty();
Chandler Carruth66445382014-01-11 08:16:35 +0000616
Chandler Carruthea368f12015-01-06 08:37:58 +0000617 // This isn't parsable as a module pipeline, look for the end of a pass name
618 // and directly drop down to that layer.
Chandler Carruth6546cb62014-01-12 10:02:02 +0000619 StringRef FirstName =
620 PipelineText.substr(0, PipelineText.find_first_of(",)"));
Chandler Carruthea368f12015-01-06 08:37:58 +0000621 assert(!isModulePassName(FirstName) &&
622 "Already handled all module pipeline options.");
Chandler Carruth66445382014-01-11 08:16:35 +0000623
Chandler Carruthea368f12015-01-06 08:37:58 +0000624 // If this looks like a CGSCC pass, parse the whole thing as a CGSCC
625 // pipeline.
Justin Bognereecc3c82016-02-25 07:23:08 +0000626 if (PipelineText.startswith("cgscc(") || isCGSCCPassName(FirstName)) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000627 CGSCCPassManager CGPM(DebugLogging);
628 if (!parseCGSCCPassPipeline(CGPM, PipelineText, VerifyEachPass,
629 DebugLogging) ||
Chandler Carruth572e3402014-04-21 11:12:00 +0000630 !PipelineText.empty())
631 return false;
632 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPM)));
633 return true;
634 }
635
Chandler Carruthea368f12015-01-06 08:37:58 +0000636 // Similarly, if this looks like a Function pass, parse the whole thing as
637 // a Function pipelien.
Justin Bognereecc3c82016-02-25 07:23:08 +0000638 if (PipelineText.startswith("function(") || isFunctionPassName(FirstName)) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000639 FunctionPassManager FPM(DebugLogging);
640 if (!parseFunctionPassPipeline(FPM, PipelineText, VerifyEachPass,
641 DebugLogging) ||
Chandler Carruth4d356312014-01-20 11:34:08 +0000642 !PipelineText.empty())
Chandler Carruthd8330982014-01-12 09:34:22 +0000643 return false;
Chandler Carruthc3f3da32014-03-09 11:49:53 +0000644 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
Chandler Carruthd8330982014-01-12 09:34:22 +0000645 return true;
646 }
Chandler Carruth66445382014-01-11 08:16:35 +0000647
Justin Bognereecc3c82016-02-25 07:23:08 +0000648 // If this looks like a Loop pass, parse the whole thing as a Loop pipeline.
649 if (PipelineText.startswith("loop(") || isLoopPassName(FirstName)) {
650 LoopPassManager LPM(DebugLogging);
651 if (!parseLoopPassPipeline(LPM, PipelineText, VerifyEachPass,
652 DebugLogging) ||
653 !PipelineText.empty())
654 return false;
655 FunctionPassManager FPM(DebugLogging);
656 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM)));
657 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
658 return true;
659 }
660
661
Chandler Carruth66445382014-01-11 08:16:35 +0000662 return false;
663}
Chandler Carruthedf59962016-02-18 09:45:17 +0000664
665bool PassBuilder::parseAAPipeline(AAManager &AA, StringRef PipelineText) {
666 while (!PipelineText.empty()) {
667 StringRef Name;
668 std::tie(Name, PipelineText) = PipelineText.split(',');
669 if (!parseAAPassName(AA, Name))
670 return false;
671 }
672
673 return true;
674}