blob: a81634cbb96641988cebbb0c951282b789097ee0 [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 Li28a93272016-05-05 21:13:27 +000024#include "llvm/Analysis/BlockFrequencyInfo.h"
25#include "llvm/Analysis/BlockFrequencyInfoImpl.h"
Xinliang David Li6e5dd412016-05-05 02:59:57 +000026#include "llvm/Analysis/BranchProbabilityInfo.h"
Chandler Carruth342c6712016-02-20 03:52:02 +000027#include "llvm/Analysis/CFLAliasAnalysis.h"
Chandler Carruth572e3402014-04-21 11:12:00 +000028#include "llvm/Analysis/CGSCCPassManager.h"
Chandler Carruth4c660f72016-03-10 11:24:11 +000029#include "llvm/Analysis/CallGraph.h"
Michael Kupersteinde16b442016-04-18 23:55:01 +000030#include "llvm/Analysis/DemandedBits.h"
Hongbin Zheng751337f2016-02-25 17:54:15 +000031#include "llvm/Analysis/DominanceFrontier.h"
Chandler Carruth45a9c202016-03-11 09:15:11 +000032#include "llvm/Analysis/GlobalsModRef.h"
Chandler Carruthbf71a342014-02-06 04:37:03 +000033#include "llvm/Analysis/LazyCallGraph.h"
Chandler Carruthaaf0b4c2015-01-20 10:58:50 +000034#include "llvm/Analysis/LoopInfo.h"
Chandler Carruth61440d22016-03-10 00:55:30 +000035#include "llvm/Analysis/MemoryDependenceAnalysis.h"
Hongbin Zheng3f978402016-02-25 17:54:07 +000036#include "llvm/Analysis/PostDominators.h"
Hongbin Zhengbc539772016-02-25 17:54:25 +000037#include "llvm/Analysis/RegionInfo.h"
Chandler Carruth2f1fd162015-08-17 02:08:17 +000038#include "llvm/Analysis/ScalarEvolution.h"
Chandler Carruth2b3d0442016-02-20 04:01:45 +000039#include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
Chandler Carruthd6091a02016-02-20 04:03:06 +000040#include "llvm/Analysis/ScopedNoAliasAA.h"
Chandler Carruth8ca43222015-01-15 11:39:46 +000041#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruthe0385522015-02-01 10:11:22 +000042#include "llvm/Analysis/TargetTransformInfo.h"
Chandler Carruthc1dc3842016-02-20 04:04:52 +000043#include "llvm/Analysis/TypeBasedAliasAnalysis.h"
Chandler Carruth64764b42015-01-14 10:19:28 +000044#include "llvm/IR/Dominators.h"
Chandler Carruth52eef882014-01-12 12:15:39 +000045#include "llvm/IR/IRPrintingPasses.h"
Chandler Carruth66445382014-01-11 08:16:35 +000046#include "llvm/IR/PassManager.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000047#include "llvm/IR/Verifier.h"
Chandler Carruth52eef882014-01-12 12:15:39 +000048#include "llvm/Support/Debug.h"
Chandler Carruth8b5a74192016-02-28 22:16:03 +000049#include "llvm/Support/Regex.h"
Chandler Carruthe0385522015-02-01 10:11:22 +000050#include "llvm/Target/TargetMachine.h"
Davide Italiano164b9bc2016-05-05 00:51:09 +000051#include "llvm/Transforms/IPO/ConstantMerge.h"
Davide Italiano344e8382016-05-05 02:37:32 +000052#include "llvm/Transforms/IPO/ElimAvailExtern.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000053#include "llvm/Transforms/IPO/ForceFunctionAttrs.h"
Chandler Carruth9c4ed172016-02-18 11:03:11 +000054#include "llvm/Transforms/IPO/FunctionAttrs.h"
Davide Italiano66228c42016-05-03 19:39:15 +000055#include "llvm/Transforms/IPO/GlobalDCE.h"
Justin Bogner1a075012016-04-26 00:28:01 +000056#include "llvm/Transforms/IPO/GlobalOpt.h"
Chandler Carruth3a040e62015-12-27 08:41:34 +000057#include "llvm/Transforms/IPO/InferFunctionAttrs.h"
Justin Bogner4563a062016-04-26 20:15:52 +000058#include "llvm/Transforms/IPO/Internalize.h"
Davide Italianof54f2f02016-05-05 21:05:36 +000059#include "llvm/Transforms/IPO/SCCP.h"
Justin Bogner21e15372015-10-30 23:28:12 +000060#include "llvm/Transforms/IPO/StripDeadPrototypes.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000061#include "llvm/Transforms/InstCombine/InstCombine.h"
Xinliang David Lie6b89292016-04-18 17:47:38 +000062#include "llvm/Transforms/InstrProfiling.h"
Justin Bogner19b67992015-10-30 23:13:18 +000063#include "llvm/Transforms/Scalar/ADCE.h"
Justin Bogner395c2122016-04-22 19:40:41 +000064#include "llvm/Transforms/Scalar/DCE.h"
Chandler Carruthe8c686a2015-02-01 10:51:23 +000065#include "llvm/Transforms/Scalar/EarlyCSE.h"
Davide Italiano164b9bc2016-05-05 00:51:09 +000066#include "llvm/Transforms/Scalar/GVN.h"
Justin Bognerd0d23412016-05-03 22:02:31 +000067#include "llvm/Transforms/Scalar/LoopRotation.h"
Justin Bognerab6a5132016-05-03 21:47:32 +000068#include "llvm/Transforms/Scalar/LoopSimplifyCFG.h"
Chandler Carruth43e590e2015-01-24 11:13:02 +000069#include "llvm/Transforms/Scalar/LowerExpectIntrinsic.h"
Justin Bognerc2bf63d2016-04-26 23:39:29 +000070#include "llvm/Transforms/Scalar/Reassociate.h"
Chandler Carruth29a18a42015-09-12 09:09:14 +000071#include "llvm/Transforms/Scalar/SROA.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000072#include "llvm/Transforms/Scalar/SimplifyCFG.h"
Justin Bognerb9394902016-04-22 19:54:10 +000073#include "llvm/Transforms/Scalar/Sink.h"
Chandler Carruth58dde8c2016-02-26 12:17:54 +000074#include <type_traits>
Chandler Carruth66445382014-01-11 08:16:35 +000075
76using namespace llvm;
77
Chandler Carruth8b5a74192016-02-28 22:16:03 +000078static Regex DefaultAliasRegex("^(default|lto-pre-link|lto)<(O[0123sz])>$");
79
Chandler Carruth66445382014-01-11 08:16:35 +000080namespace {
81
Chandler Carruthd8330982014-01-12 09:34:22 +000082/// \brief No-op module pass which does nothing.
Chandler Carruth66445382014-01-11 08:16:35 +000083struct NoOpModulePass {
Chandler Carruthd174ce42015-01-05 02:47:05 +000084 PreservedAnalyses run(Module &M) { return PreservedAnalyses::all(); }
Chandler Carrutha13f27c2014-01-11 11:52:05 +000085 static StringRef name() { return "NoOpModulePass"; }
Chandler Carruth66445382014-01-11 08:16:35 +000086};
87
Chandler Carruth0b576b32015-01-06 02:50:06 +000088/// \brief No-op module analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +000089class NoOpModuleAnalysis : public AnalysisInfoMixin<NoOpModuleAnalysis> {
90 friend AnalysisInfoMixin<NoOpModuleAnalysis>;
Chandler Carruthb4faf132016-03-11 10:22:49 +000091 static char PassID;
92
93public:
Chandler Carruth0b576b32015-01-06 02:50:06 +000094 struct Result {};
95 Result run(Module &) { return Result(); }
96 static StringRef name() { return "NoOpModuleAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +000097};
98
Chandler Carruth572e3402014-04-21 11:12:00 +000099/// \brief No-op CGSCC pass which does nothing.
100struct NoOpCGSCCPass {
Chandler Carruthd174ce42015-01-05 02:47:05 +0000101 PreservedAnalyses run(LazyCallGraph::SCC &C) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000102 return PreservedAnalyses::all();
103 }
104 static StringRef name() { return "NoOpCGSCCPass"; }
105};
106
Chandler Carruth0b576b32015-01-06 02:50:06 +0000107/// \brief No-op CGSCC analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000108class NoOpCGSCCAnalysis : public AnalysisInfoMixin<NoOpCGSCCAnalysis> {
109 friend AnalysisInfoMixin<NoOpCGSCCAnalysis>;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000110 static char PassID;
111
112public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000113 struct Result {};
114 Result run(LazyCallGraph::SCC &) { return Result(); }
115 static StringRef name() { return "NoOpCGSCCAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000116};
117
Chandler Carruthd8330982014-01-12 09:34:22 +0000118/// \brief No-op function pass which does nothing.
119struct NoOpFunctionPass {
Chandler Carruthd174ce42015-01-05 02:47:05 +0000120 PreservedAnalyses run(Function &F) { return PreservedAnalyses::all(); }
Chandler Carruthd8330982014-01-12 09:34:22 +0000121 static StringRef name() { return "NoOpFunctionPass"; }
122};
123
Chandler Carruth0b576b32015-01-06 02:50:06 +0000124/// \brief No-op function analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000125class NoOpFunctionAnalysis : public AnalysisInfoMixin<NoOpFunctionAnalysis> {
126 friend AnalysisInfoMixin<NoOpFunctionAnalysis>;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000127 static char PassID;
128
129public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000130 struct Result {};
131 Result run(Function &) { return Result(); }
132 static StringRef name() { return "NoOpFunctionAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000133};
134
Justin Bognereecc3c82016-02-25 07:23:08 +0000135/// \brief No-op loop pass which does nothing.
136struct NoOpLoopPass {
137 PreservedAnalyses run(Loop &L) { return PreservedAnalyses::all(); }
138 static StringRef name() { return "NoOpLoopPass"; }
139};
140
141/// \brief No-op loop analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000142class NoOpLoopAnalysis : public AnalysisInfoMixin<NoOpLoopAnalysis> {
143 friend AnalysisInfoMixin<NoOpLoopAnalysis>;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000144 static char PassID;
145
146public:
Justin Bognereecc3c82016-02-25 07:23:08 +0000147 struct Result {};
148 Result run(Loop &) { return Result(); }
149 static StringRef name() { return "NoOpLoopAnalysis"; }
Justin Bognereecc3c82016-02-25 07:23:08 +0000150};
151
Chandler Carruthb4faf132016-03-11 10:22:49 +0000152char NoOpModuleAnalysis::PassID;
153char NoOpCGSCCAnalysis::PassID;
154char NoOpFunctionAnalysis::PassID;
155char NoOpLoopAnalysis::PassID;
156
Chandler Carruth66445382014-01-11 08:16:35 +0000157} // End anonymous namespace.
158
Chandler Carruth1ff77242015-03-07 09:02:36 +0000159void PassBuilder::registerModuleAnalyses(ModuleAnalysisManager &MAM) {
Chandler Carruthb70f6732015-01-06 02:21:37 +0000160#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000161 MAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000162#include "PassRegistry.def"
163}
164
Chandler Carruth1ff77242015-03-07 09:02:36 +0000165void PassBuilder::registerCGSCCAnalyses(CGSCCAnalysisManager &CGAM) {
Chandler Carruthb70f6732015-01-06 02:21:37 +0000166#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000167 CGAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000168#include "PassRegistry.def"
169}
170
Chandler Carruth1ff77242015-03-07 09:02:36 +0000171void PassBuilder::registerFunctionAnalyses(FunctionAnalysisManager &FAM) {
Chandler Carruthb70f6732015-01-06 02:21:37 +0000172#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000173 FAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000174#include "PassRegistry.def"
175}
176
Justin Bognereecc3c82016-02-25 07:23:08 +0000177void PassBuilder::registerLoopAnalyses(LoopAnalysisManager &LAM) {
178#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
179 LAM.registerPass([&] { return CREATE_PASS; });
180#include "PassRegistry.def"
181}
182
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000183void PassBuilder::addPerModuleDefaultPipeline(ModulePassManager &MPM,
184 OptimizationLevel Level,
185 bool DebugLogging) {
186 // FIXME: Finish fleshing this out to match the legacy pipelines.
187 FunctionPassManager EarlyFPM(DebugLogging);
188 EarlyFPM.addPass(SimplifyCFGPass());
189 EarlyFPM.addPass(SROA());
190 EarlyFPM.addPass(EarlyCSEPass());
191 EarlyFPM.addPass(LowerExpectIntrinsicPass());
192
193 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(EarlyFPM)));
194}
195
196void PassBuilder::addLTOPreLinkDefaultPipeline(ModulePassManager &MPM,
197 OptimizationLevel Level,
198 bool DebugLogging) {
199 // FIXME: We should use a customized pre-link pipeline!
200 addPerModuleDefaultPipeline(MPM, Level, DebugLogging);
201}
202
203void PassBuilder::addLTODefaultPipeline(ModulePassManager &MPM,
204 OptimizationLevel Level,
205 bool DebugLogging) {
206 // FIXME: Finish fleshing this out to match the legacy LTO pipelines.
207 FunctionPassManager LateFPM(DebugLogging);
208 LateFPM.addPass(InstCombinePass());
209 LateFPM.addPass(SimplifyCFGPass());
210
211 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(LateFPM)));
212}
213
Chandler Carruth9d2e58f2015-01-06 09:10:47 +0000214#ifndef NDEBUG
Chandler Carruth66445382014-01-11 08:16:35 +0000215static bool isModulePassName(StringRef Name) {
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000216 // Manually handle aliases for pre-configured pipeline fragments.
217 if (Name.startswith("default") || Name.startswith("lto"))
218 return DefaultAliasRegex.match(Name);
219
Chandler Carruth58944182014-04-21 08:08:50 +0000220#define MODULE_PASS(NAME, CREATE_PASS) if (Name == NAME) return true;
Chandler Carruth628503e2015-01-06 02:10:51 +0000221#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000222 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +0000223 return true;
224#include "PassRegistry.def"
225
Chandler Carruth66445382014-01-11 08:16:35 +0000226 return false;
227}
Chandler Carruth9d2e58f2015-01-06 09:10:47 +0000228#endif
Chandler Carruth66445382014-01-11 08:16:35 +0000229
Chandler Carruth572e3402014-04-21 11:12:00 +0000230static bool isCGSCCPassName(StringRef Name) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000231#define CGSCC_PASS(NAME, CREATE_PASS) if (Name == NAME) return true;
Chandler Carruth628503e2015-01-06 02:10:51 +0000232#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000233 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +0000234 return true;
235#include "PassRegistry.def"
236
Chandler Carruth572e3402014-04-21 11:12:00 +0000237 return false;
238}
239
Chandler Carruthd8330982014-01-12 09:34:22 +0000240static bool isFunctionPassName(StringRef Name) {
Chandler Carruth58944182014-04-21 08:08:50 +0000241#define FUNCTION_PASS(NAME, CREATE_PASS) if (Name == NAME) return true;
Chandler Carruth628503e2015-01-06 02:10:51 +0000242#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000243 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +0000244 return true;
245#include "PassRegistry.def"
246
Chandler Carruthd8330982014-01-12 09:34:22 +0000247 return false;
248}
249
Justin Bognereecc3c82016-02-25 07:23:08 +0000250static bool isLoopPassName(StringRef Name) {
251#define LOOP_PASS(NAME, CREATE_PASS) if (Name == NAME) return true;
252#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
253 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
254 return true;
255#include "PassRegistry.def"
256
257 return false;
258}
259
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000260bool PassBuilder::parseModulePassName(ModulePassManager &MPM, StringRef Name,
261 bool DebugLogging) {
262 // Manually handle aliases for pre-configured pipeline fragments.
263 if (Name.startswith("default") || Name.startswith("lto")) {
264 SmallVector<StringRef, 3> Matches;
265 if (!DefaultAliasRegex.match(Name, &Matches))
266 return false;
267 assert(Matches.size() == 3 && "Must capture two matched strings!");
268
269 auto L = StringSwitch<OptimizationLevel>(Matches[2])
270 .Case("O0", O0)
271 .Case("O1", O1)
272 .Case("O2", O2)
273 .Case("O3", O3)
274 .Case("Os", Os)
275 .Case("Oz", Oz);
276
277 if (Matches[1] == "default") {
278 addPerModuleDefaultPipeline(MPM, L, DebugLogging);
279 } else if (Matches[1] == "lto-pre-link") {
280 addLTOPreLinkDefaultPipeline(MPM, L, DebugLogging);
281 } else {
282 assert(Matches[1] == "lto" && "Not one of the matched options!");
283 addLTODefaultPipeline(MPM, L, DebugLogging);
284 }
285 return true;
286 }
287
Chandler Carruth58944182014-04-21 08:08:50 +0000288#define MODULE_PASS(NAME, CREATE_PASS) \
289 if (Name == NAME) { \
290 MPM.addPass(CREATE_PASS); \
291 return true; \
Chandler Carruth52eef882014-01-12 12:15:39 +0000292 }
Chandler Carruth628503e2015-01-06 02:10:51 +0000293#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
294 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000295 MPM.addPass(RequireAnalysisPass< \
296 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +0000297 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000298 } \
299 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000300 MPM.addPass(InvalidateAnalysisPass< \
301 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000302 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +0000303 }
304#include "PassRegistry.def"
305
Chandler Carruth66445382014-01-11 08:16:35 +0000306 return false;
307}
308
Chandler Carruth1ff77242015-03-07 09:02:36 +0000309bool PassBuilder::parseCGSCCPassName(CGSCCPassManager &CGPM, StringRef Name) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000310#define CGSCC_PASS(NAME, CREATE_PASS) \
311 if (Name == NAME) { \
312 CGPM.addPass(CREATE_PASS); \
313 return true; \
314 }
Chandler Carruth628503e2015-01-06 02:10:51 +0000315#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
316 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000317 CGPM.addPass(RequireAnalysisPass< \
318 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +0000319 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000320 } \
321 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000322 CGPM.addPass(InvalidateAnalysisPass< \
323 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000324 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +0000325 }
326#include "PassRegistry.def"
327
Chandler Carruth572e3402014-04-21 11:12:00 +0000328 return false;
329}
330
Chandler Carruth1ff77242015-03-07 09:02:36 +0000331bool PassBuilder::parseFunctionPassName(FunctionPassManager &FPM,
332 StringRef Name) {
Chandler Carruth58944182014-04-21 08:08:50 +0000333#define FUNCTION_PASS(NAME, CREATE_PASS) \
334 if (Name == NAME) { \
335 FPM.addPass(CREATE_PASS); \
336 return true; \
Chandler Carruth52eef882014-01-12 12:15:39 +0000337 }
Chandler Carruth628503e2015-01-06 02:10:51 +0000338#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
339 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000340 FPM.addPass(RequireAnalysisPass< \
341 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +0000342 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000343 } \
344 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000345 FPM.addPass(InvalidateAnalysisPass< \
346 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +0000347 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +0000348 }
349#include "PassRegistry.def"
350
Chandler Carruthd8330982014-01-12 09:34:22 +0000351 return false;
352}
353
Justin Bognereecc3c82016-02-25 07:23:08 +0000354bool PassBuilder::parseLoopPassName(LoopPassManager &FPM,
355 StringRef Name) {
356#define LOOP_PASS(NAME, CREATE_PASS) \
357 if (Name == NAME) { \
358 FPM.addPass(CREATE_PASS); \
359 return true; \
360 }
361#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
362 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000363 FPM.addPass(RequireAnalysisPass< \
364 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Justin Bognereecc3c82016-02-25 07:23:08 +0000365 return true; \
366 } \
367 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +0000368 FPM.addPass(InvalidateAnalysisPass< \
369 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Justin Bognereecc3c82016-02-25 07:23:08 +0000370 return true; \
371 }
372#include "PassRegistry.def"
373
374 return false;
375}
376
Chandler Carruthedf59962016-02-18 09:45:17 +0000377bool PassBuilder::parseAAPassName(AAManager &AA, StringRef Name) {
Chandler Carruth45a9c202016-03-11 09:15:11 +0000378#define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
379 if (Name == NAME) { \
380 AA.registerModuleAnalysis< \
381 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
382 return true; \
383 }
Chandler Carruthedf59962016-02-18 09:45:17 +0000384#define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
385 if (Name == NAME) { \
Chandler Carruth58dde8c2016-02-26 12:17:54 +0000386 AA.registerFunctionAnalysis< \
387 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
Chandler Carruthedf59962016-02-18 09:45:17 +0000388 return true; \
389 }
390#include "PassRegistry.def"
391
392 return false;
393}
394
Justin Bognereecc3c82016-02-25 07:23:08 +0000395bool PassBuilder::parseLoopPassPipeline(LoopPassManager &LPM,
396 StringRef &PipelineText,
397 bool VerifyEachPass,
398 bool DebugLogging) {
399 for (;;) {
400 // Parse nested pass managers by recursing.
401 if (PipelineText.startswith("loop(")) {
402 LoopPassManager NestedLPM(DebugLogging);
403
404 // Parse the inner pipeline inte the nested manager.
405 PipelineText = PipelineText.substr(strlen("loop("));
406 if (!parseLoopPassPipeline(NestedLPM, PipelineText, VerifyEachPass,
407 DebugLogging) ||
408 PipelineText.empty())
409 return false;
410 assert(PipelineText[0] == ')');
411 PipelineText = PipelineText.substr(1);
412
413 // Add the nested pass manager with the appropriate adaptor.
414 LPM.addPass(std::move(NestedLPM));
415 } else {
416 // Otherwise try to parse a pass name.
417 size_t End = PipelineText.find_first_of(",)");
418 if (!parseLoopPassName(LPM, PipelineText.substr(0, End)))
419 return false;
420 // TODO: Ideally, we would run a LoopVerifierPass() here in the
421 // VerifyEachPass case, but we don't have such a verifier yet.
422
423 PipelineText = PipelineText.substr(End);
424 }
425
426 if (PipelineText.empty() || PipelineText[0] == ')')
427 return true;
428
429 assert(PipelineText[0] == ',');
430 PipelineText = PipelineText.substr(1);
431 }
432}
433
Chandler Carruth1ff77242015-03-07 09:02:36 +0000434bool PassBuilder::parseFunctionPassPipeline(FunctionPassManager &FPM,
435 StringRef &PipelineText,
436 bool VerifyEachPass,
437 bool DebugLogging) {
Chandler Carruthd8330982014-01-12 09:34:22 +0000438 for (;;) {
439 // Parse nested pass managers by recursing.
440 if (PipelineText.startswith("function(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000441 FunctionPassManager NestedFPM(DebugLogging);
Chandler Carruthd8330982014-01-12 09:34:22 +0000442
443 // Parse the inner pipeline inte the nested manager.
444 PipelineText = PipelineText.substr(strlen("function("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000445 if (!parseFunctionPassPipeline(NestedFPM, PipelineText, VerifyEachPass,
446 DebugLogging) ||
Chandler Carruth6546cb62014-01-12 10:02:02 +0000447 PipelineText.empty())
Chandler Carruthd8330982014-01-12 09:34:22 +0000448 return false;
Chandler Carruth6546cb62014-01-12 10:02:02 +0000449 assert(PipelineText[0] == ')');
Chandler Carruthd8330982014-01-12 09:34:22 +0000450 PipelineText = PipelineText.substr(1);
451
452 // Add the nested pass manager with the appropriate adaptor.
Chandler Carruthc3f3da32014-03-09 11:49:53 +0000453 FPM.addPass(std::move(NestedFPM));
Justin Bognereecc3c82016-02-25 07:23:08 +0000454 } else if (PipelineText.startswith("loop(")) {
455 LoopPassManager NestedLPM(DebugLogging);
456
457 // Parse the inner pipeline inte the nested manager.
458 PipelineText = PipelineText.substr(strlen("loop("));
459 if (!parseLoopPassPipeline(NestedLPM, PipelineText, VerifyEachPass,
460 DebugLogging) ||
461 PipelineText.empty())
462 return false;
463 assert(PipelineText[0] == ')');
464 PipelineText = PipelineText.substr(1);
465
466 // Add the nested pass manager with the appropriate adaptor.
467 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(NestedLPM)));
Chandler Carruthd8330982014-01-12 09:34:22 +0000468 } else {
469 // Otherwise try to parse a pass name.
470 size_t End = PipelineText.find_first_of(",)");
471 if (!parseFunctionPassName(FPM, PipelineText.substr(0, End)))
472 return false;
Chandler Carruth4d356312014-01-20 11:34:08 +0000473 if (VerifyEachPass)
474 FPM.addPass(VerifierPass());
Chandler Carruthd8330982014-01-12 09:34:22 +0000475
476 PipelineText = PipelineText.substr(End);
477 }
478
479 if (PipelineText.empty() || PipelineText[0] == ')')
480 return true;
481
482 assert(PipelineText[0] == ',');
483 PipelineText = PipelineText.substr(1);
484 }
485}
486
Chandler Carruth1ff77242015-03-07 09:02:36 +0000487bool PassBuilder::parseCGSCCPassPipeline(CGSCCPassManager &CGPM,
488 StringRef &PipelineText,
489 bool VerifyEachPass,
490 bool DebugLogging) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000491 for (;;) {
492 // Parse nested pass managers by recursing.
493 if (PipelineText.startswith("cgscc(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000494 CGSCCPassManager NestedCGPM(DebugLogging);
Chandler Carruth572e3402014-04-21 11:12:00 +0000495
496 // Parse the inner pipeline into the nested manager.
497 PipelineText = PipelineText.substr(strlen("cgscc("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000498 if (!parseCGSCCPassPipeline(NestedCGPM, PipelineText, VerifyEachPass,
499 DebugLogging) ||
Chandler Carruth572e3402014-04-21 11:12:00 +0000500 PipelineText.empty())
501 return false;
502 assert(PipelineText[0] == ')');
503 PipelineText = PipelineText.substr(1);
504
505 // Add the nested pass manager with the appropriate adaptor.
506 CGPM.addPass(std::move(NestedCGPM));
507 } else if (PipelineText.startswith("function(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000508 FunctionPassManager NestedFPM(DebugLogging);
Chandler Carruth572e3402014-04-21 11:12:00 +0000509
510 // Parse the inner pipeline inte the nested manager.
511 PipelineText = PipelineText.substr(strlen("function("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000512 if (!parseFunctionPassPipeline(NestedFPM, PipelineText, VerifyEachPass,
513 DebugLogging) ||
Chandler Carruth572e3402014-04-21 11:12:00 +0000514 PipelineText.empty())
515 return false;
516 assert(PipelineText[0] == ')');
517 PipelineText = PipelineText.substr(1);
518
519 // Add the nested pass manager with the appropriate adaptor.
520 CGPM.addPass(createCGSCCToFunctionPassAdaptor(std::move(NestedFPM)));
521 } else {
522 // Otherwise try to parse a pass name.
523 size_t End = PipelineText.find_first_of(",)");
524 if (!parseCGSCCPassName(CGPM, PipelineText.substr(0, End)))
525 return false;
526 // FIXME: No verifier support for CGSCC passes!
527
528 PipelineText = PipelineText.substr(End);
529 }
530
531 if (PipelineText.empty() || PipelineText[0] == ')')
532 return true;
533
534 assert(PipelineText[0] == ',');
535 PipelineText = PipelineText.substr(1);
536 }
537}
538
Chandler Carruth1ff77242015-03-07 09:02:36 +0000539bool PassBuilder::parseModulePassPipeline(ModulePassManager &MPM,
540 StringRef &PipelineText,
541 bool VerifyEachPass,
542 bool DebugLogging) {
Chandler Carruth66445382014-01-11 08:16:35 +0000543 for (;;) {
544 // Parse nested pass managers by recursing.
545 if (PipelineText.startswith("module(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000546 ModulePassManager NestedMPM(DebugLogging);
Chandler Carruth258dbb32014-01-11 12:06:47 +0000547
548 // Parse the inner pipeline into the nested manager.
Chandler Carruth66445382014-01-11 08:16:35 +0000549 PipelineText = PipelineText.substr(strlen("module("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000550 if (!parseModulePassPipeline(NestedMPM, PipelineText, VerifyEachPass,
551 DebugLogging) ||
Chandler Carruth6546cb62014-01-12 10:02:02 +0000552 PipelineText.empty())
Chandler Carruth66445382014-01-11 08:16:35 +0000553 return false;
Chandler Carruth6546cb62014-01-12 10:02:02 +0000554 assert(PipelineText[0] == ')');
Chandler Carruth66445382014-01-11 08:16:35 +0000555 PipelineText = PipelineText.substr(1);
Chandler Carruth258dbb32014-01-11 12:06:47 +0000556
557 // Now add the nested manager as a module pass.
Chandler Carruthc3f3da32014-03-09 11:49:53 +0000558 MPM.addPass(std::move(NestedMPM));
Chandler Carruth572e3402014-04-21 11:12:00 +0000559 } else if (PipelineText.startswith("cgscc(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000560 CGSCCPassManager NestedCGPM(DebugLogging);
Chandler Carruth572e3402014-04-21 11:12:00 +0000561
562 // Parse the inner pipeline inte the nested manager.
563 PipelineText = PipelineText.substr(strlen("cgscc("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000564 if (!parseCGSCCPassPipeline(NestedCGPM, PipelineText, VerifyEachPass,
565 DebugLogging) ||
Chandler Carruth572e3402014-04-21 11:12:00 +0000566 PipelineText.empty())
567 return false;
568 assert(PipelineText[0] == ')');
569 PipelineText = PipelineText.substr(1);
570
571 // Add the nested pass manager with the appropriate adaptor.
572 MPM.addPass(
573 createModuleToPostOrderCGSCCPassAdaptor(std::move(NestedCGPM)));
Chandler Carruthd8330982014-01-12 09:34:22 +0000574 } else if (PipelineText.startswith("function(")) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000575 FunctionPassManager NestedFPM(DebugLogging);
Chandler Carruthd8330982014-01-12 09:34:22 +0000576
577 // Parse the inner pipeline inte the nested manager.
578 PipelineText = PipelineText.substr(strlen("function("));
Chandler Carruth14a759e2015-01-13 22:42:38 +0000579 if (!parseFunctionPassPipeline(NestedFPM, PipelineText, VerifyEachPass,
580 DebugLogging) ||
Chandler Carruth6546cb62014-01-12 10:02:02 +0000581 PipelineText.empty())
Chandler Carruthd8330982014-01-12 09:34:22 +0000582 return false;
Chandler Carruth6546cb62014-01-12 10:02:02 +0000583 assert(PipelineText[0] == ')');
Chandler Carruthd8330982014-01-12 09:34:22 +0000584 PipelineText = PipelineText.substr(1);
585
586 // Add the nested pass manager with the appropriate adaptor.
Chandler Carruthc3f3da32014-03-09 11:49:53 +0000587 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(NestedFPM)));
Chandler Carruth66445382014-01-11 08:16:35 +0000588 } else {
589 // Otherwise try to parse a pass name.
590 size_t End = PipelineText.find_first_of(",)");
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000591 if (!parseModulePassName(MPM, PipelineText.substr(0, End), DebugLogging))
Chandler Carruth66445382014-01-11 08:16:35 +0000592 return false;
Chandler Carruth4d356312014-01-20 11:34:08 +0000593 if (VerifyEachPass)
594 MPM.addPass(VerifierPass());
Chandler Carruth66445382014-01-11 08:16:35 +0000595
596 PipelineText = PipelineText.substr(End);
597 }
598
599 if (PipelineText.empty() || PipelineText[0] == ')')
600 return true;
601
602 assert(PipelineText[0] == ',');
603 PipelineText = PipelineText.substr(1);
604 }
605}
606
607// Primary pass pipeline description parsing routine.
608// FIXME: Should this routine accept a TargetMachine or require the caller to
609// pre-populate the analysis managers with target-specific stuff?
Chandler Carruth1ff77242015-03-07 09:02:36 +0000610bool PassBuilder::parsePassPipeline(ModulePassManager &MPM,
611 StringRef PipelineText, bool VerifyEachPass,
612 bool DebugLogging) {
Chandler Carruthea368f12015-01-06 08:37:58 +0000613 // By default, try to parse the pipeline as-if it were within an implicit
614 // 'module(...)' pass pipeline. If this will parse at all, it needs to
615 // consume the entire string.
Chandler Carruth14a759e2015-01-13 22:42:38 +0000616 if (parseModulePassPipeline(MPM, PipelineText, VerifyEachPass, DebugLogging))
Chandler Carruthea368f12015-01-06 08:37:58 +0000617 return PipelineText.empty();
Chandler Carruth66445382014-01-11 08:16:35 +0000618
Chandler Carruthea368f12015-01-06 08:37:58 +0000619 // This isn't parsable as a module pipeline, look for the end of a pass name
620 // and directly drop down to that layer.
Chandler Carruth6546cb62014-01-12 10:02:02 +0000621 StringRef FirstName =
622 PipelineText.substr(0, PipelineText.find_first_of(",)"));
Chandler Carruthea368f12015-01-06 08:37:58 +0000623 assert(!isModulePassName(FirstName) &&
624 "Already handled all module pipeline options.");
Chandler Carruth66445382014-01-11 08:16:35 +0000625
Chandler Carruthea368f12015-01-06 08:37:58 +0000626 // If this looks like a CGSCC pass, parse the whole thing as a CGSCC
627 // pipeline.
Justin Bognereecc3c82016-02-25 07:23:08 +0000628 if (PipelineText.startswith("cgscc(") || isCGSCCPassName(FirstName)) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000629 CGSCCPassManager CGPM(DebugLogging);
630 if (!parseCGSCCPassPipeline(CGPM, PipelineText, VerifyEachPass,
631 DebugLogging) ||
Chandler Carruth572e3402014-04-21 11:12:00 +0000632 !PipelineText.empty())
633 return false;
634 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPM)));
635 return true;
636 }
637
Chandler Carruthea368f12015-01-06 08:37:58 +0000638 // Similarly, if this looks like a Function pass, parse the whole thing as
639 // a Function pipelien.
Justin Bognereecc3c82016-02-25 07:23:08 +0000640 if (PipelineText.startswith("function(") || isFunctionPassName(FirstName)) {
Chandler Carruth14a759e2015-01-13 22:42:38 +0000641 FunctionPassManager FPM(DebugLogging);
642 if (!parseFunctionPassPipeline(FPM, PipelineText, VerifyEachPass,
643 DebugLogging) ||
Chandler Carruth4d356312014-01-20 11:34:08 +0000644 !PipelineText.empty())
Chandler Carruthd8330982014-01-12 09:34:22 +0000645 return false;
Chandler Carruthc3f3da32014-03-09 11:49:53 +0000646 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
Chandler Carruthd8330982014-01-12 09:34:22 +0000647 return true;
648 }
Chandler Carruth66445382014-01-11 08:16:35 +0000649
Justin Bognereecc3c82016-02-25 07:23:08 +0000650 // If this looks like a Loop pass, parse the whole thing as a Loop pipeline.
651 if (PipelineText.startswith("loop(") || isLoopPassName(FirstName)) {
652 LoopPassManager LPM(DebugLogging);
653 if (!parseLoopPassPipeline(LPM, PipelineText, VerifyEachPass,
654 DebugLogging) ||
655 !PipelineText.empty())
656 return false;
657 FunctionPassManager FPM(DebugLogging);
658 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM)));
659 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
660 return true;
661 }
662
663
Chandler Carruth66445382014-01-11 08:16:35 +0000664 return false;
665}
Chandler Carruthedf59962016-02-18 09:45:17 +0000666
667bool PassBuilder::parseAAPipeline(AAManager &AA, StringRef PipelineText) {
668 while (!PipelineText.empty()) {
669 StringRef Name;
670 std::tie(Name, PipelineText) = PipelineText.split(',');
671 if (!parseAAPassName(AA, Name))
672 return false;
673 }
674
675 return true;
676}