blob: 0380bd991d71720f46a60ff61976848f09ab8663 [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"
Daniel Jasperaec2fa32016-12-19 08:22:17 +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"
Mehdi Amini27d23792016-09-16 16:56:30 +000027#include "llvm/Analysis/CFGPrinter.h"
George Burgess IVbfa401e2016-07-06 00:26:41 +000028#include "llvm/Analysis/CFLAndersAliasAnalysis.h"
29#include "llvm/Analysis/CFLSteensAliasAnalysis.h"
Chandler Carruth572e3402014-04-21 11:12:00 +000030#include "llvm/Analysis/CGSCCPassManager.h"
Chandler Carruth4c660f72016-03-10 11:24:11 +000031#include "llvm/Analysis/CallGraph.h"
Michael Kupersteinde16b442016-04-18 23:55:01 +000032#include "llvm/Analysis/DemandedBits.h"
Chandler Carruth49c22192016-05-12 22:19:39 +000033#include "llvm/Analysis/DependenceAnalysis.h"
Hongbin Zheng751337f2016-02-25 17:54:15 +000034#include "llvm/Analysis/DominanceFrontier.h"
Chandler Carruth45a9c202016-03-11 09:15:11 +000035#include "llvm/Analysis/GlobalsModRef.h"
Dehao Chen1a444522016-07-16 22:51:33 +000036#include "llvm/Analysis/IVUsers.h"
Chandler Carruthbf71a342014-02-06 04:37:03 +000037#include "llvm/Analysis/LazyCallGraph.h"
Sean Silva687019f2016-06-13 22:01:25 +000038#include "llvm/Analysis/LazyValueInfo.h"
Xinliang David Li8a021312016-07-02 21:18:40 +000039#include "llvm/Analysis/LoopAccessAnalysis.h"
Chandler Carruthaaf0b4c2015-01-20 10:58:50 +000040#include "llvm/Analysis/LoopInfo.h"
Chandler Carruth61440d22016-03-10 00:55:30 +000041#include "llvm/Analysis/MemoryDependenceAnalysis.h"
Daniel Berlin554dcd82017-04-11 20:06:36 +000042#include "llvm/Analysis/MemorySSA.h"
Teresa Johnsonf93b2462016-08-12 13:53:02 +000043#include "llvm/Analysis/ModuleSummaryAnalysis.h"
Adam Nemet79ac42a2016-07-18 16:29:21 +000044#include "llvm/Analysis/OptimizationDiagnosticInfo.h"
Hongbin Zheng3f978402016-02-25 17:54:07 +000045#include "llvm/Analysis/PostDominators.h"
Easwaran Raman019e0bf2016-06-03 22:54:26 +000046#include "llvm/Analysis/ProfileSummaryInfo.h"
Hongbin Zhengbc539772016-02-25 17:54:25 +000047#include "llvm/Analysis/RegionInfo.h"
Chandler Carruth2f1fd162015-08-17 02:08:17 +000048#include "llvm/Analysis/ScalarEvolution.h"
Chandler Carruth2b3d0442016-02-20 04:01:45 +000049#include "llvm/Analysis/ScalarEvolutionAliasAnalysis.h"
Chandler Carruthd6091a02016-02-20 04:03:06 +000050#include "llvm/Analysis/ScopedNoAliasAA.h"
Chandler Carruth8ca43222015-01-15 11:39:46 +000051#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruthe0385522015-02-01 10:11:22 +000052#include "llvm/Analysis/TargetTransformInfo.h"
Chandler Carruthc1dc3842016-02-20 04:04:52 +000053#include "llvm/Analysis/TypeBasedAliasAnalysis.h"
Michael Kuperstein82d5da52016-06-24 20:13:42 +000054#include "llvm/CodeGen/PreISelIntrinsicLowering.h"
Wei Mi90d195a2016-07-08 03:32:49 +000055#include "llvm/CodeGen/UnreachableBlockElim.h"
Chandler Carruth64764b42015-01-14 10:19:28 +000056#include "llvm/IR/Dominators.h"
Chandler Carruth52eef882014-01-12 12:15:39 +000057#include "llvm/IR/IRPrintingPasses.h"
Chandler Carruth66445382014-01-11 08:16:35 +000058#include "llvm/IR/PassManager.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000059#include "llvm/IR/Verifier.h"
Chandler Carruth52eef882014-01-12 12:15:39 +000060#include "llvm/Support/Debug.h"
Chandler Carruth8b5a74192016-02-28 22:16:03 +000061#include "llvm/Support/Regex.h"
Chandler Carruthe0385522015-02-01 10:11:22 +000062#include "llvm/Target/TargetMachine.h"
Xinliang David Li64dbb292016-06-05 05:12:23 +000063#include "llvm/Transforms/GCOVProfiler.h"
Chandler Carruth67fc52f2016-08-17 02:56:20 +000064#include "llvm/Transforms/IPO/AlwaysInliner.h"
Chandler Carruthaddcda42017-02-09 23:46:27 +000065#include "llvm/Transforms/IPO/ArgumentPromotion.h"
Davide Italiano164b9bc2016-05-05 00:51:09 +000066#include "llvm/Transforms/IPO/ConstantMerge.h"
Davide Italiano92b933a2016-07-09 03:25:35 +000067#include "llvm/Transforms/IPO/CrossDSOCFI.h"
Sean Silvae3bb4572016-06-12 09:16:39 +000068#include "llvm/Transforms/IPO/DeadArgumentElimination.h"
Davide Italiano344e8382016-05-05 02:37:32 +000069#include "llvm/Transforms/IPO/ElimAvailExtern.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000070#include "llvm/Transforms/IPO/ForceFunctionAttrs.h"
Chandler Carruth9c4ed172016-02-18 11:03:11 +000071#include "llvm/Transforms/IPO/FunctionAttrs.h"
Teresa Johnson21241572016-07-18 21:22:24 +000072#include "llvm/Transforms/IPO/FunctionImport.h"
Davide Italiano66228c42016-05-03 19:39:15 +000073#include "llvm/Transforms/IPO/GlobalDCE.h"
Justin Bogner1a075012016-04-26 00:28:01 +000074#include "llvm/Transforms/IPO/GlobalOpt.h"
Davide Italiano2ae76dd2016-11-21 00:28:23 +000075#include "llvm/Transforms/IPO/GlobalSplit.h"
Chandler Carruth3a040e62015-12-27 08:41:34 +000076#include "llvm/Transforms/IPO/InferFunctionAttrs.h"
Chandler Carruth1d963112016-12-20 03:15:32 +000077#include "llvm/Transforms/IPO/Inliner.h"
Justin Bogner4563a062016-04-26 20:15:52 +000078#include "llvm/Transforms/IPO/Internalize.h"
Davide Italianoe8ae0b52016-07-11 18:10:06 +000079#include "llvm/Transforms/IPO/LowerTypeTests.h"
Easwaran Raman1832bf62016-06-27 16:50:18 +000080#include "llvm/Transforms/IPO/PartialInlining.h"
Davide Italianof54f2f02016-05-05 21:05:36 +000081#include "llvm/Transforms/IPO/SCCP.h"
Justin Bogner21e15372015-10-30 23:28:12 +000082#include "llvm/Transforms/IPO/StripDeadPrototypes.h"
Davide Italianod737dd22016-06-14 21:44:19 +000083#include "llvm/Transforms/IPO/WholeProgramDevirt.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000084#include "llvm/Transforms/InstCombine/InstCombine.h"
Xinliang David Lie6b89292016-04-18 17:47:38 +000085#include "llvm/Transforms/InstrProfiling.h"
Xinliang David Li8aebf442016-05-06 05:49:19 +000086#include "llvm/Transforms/PGOInstrumentation.h"
Xinliang David Lid38392e2016-05-27 23:20:16 +000087#include "llvm/Transforms/SampleProfile.h"
Justin Bogner19b67992015-10-30 23:13:18 +000088#include "llvm/Transforms/Scalar/ADCE.h"
Sean Silvaa4c2d152016-06-15 06:18:01 +000089#include "llvm/Transforms/Scalar/AlignmentFromAssumptions.h"
Davide Italiano655a1452016-05-25 01:57:04 +000090#include "llvm/Transforms/Scalar/BDCE.h"
Adam Nemet3beef412016-07-18 16:29:17 +000091#include "llvm/Transforms/Scalar/ConstantHoisting.h"
Sean Silvab025d372016-07-06 23:26:29 +000092#include "llvm/Transforms/Scalar/CorrelatedValuePropagation.h"
Justin Bogner395c2122016-04-22 19:40:41 +000093#include "llvm/Transforms/Scalar/DCE.h"
Justin Bogner594e07b2016-05-17 21:38:13 +000094#include "llvm/Transforms/Scalar/DeadStoreElimination.h"
Chandler Carruthe8c686a2015-02-01 10:51:23 +000095#include "llvm/Transforms/Scalar/EarlyCSE.h"
Michael Kuperstein83b753d2016-06-24 23:32:02 +000096#include "llvm/Transforms/Scalar/Float2Int.h"
Easwaran Raman019e0bf2016-06-03 22:54:26 +000097#include "llvm/Transforms/Scalar/GVN.h"
Davide Italiano89ab89d2016-06-14 00:49:23 +000098#include "llvm/Transforms/Scalar/GuardWidening.h"
Chandler Carruth3bab7e12017-01-11 09:43:56 +000099#include "llvm/Transforms/Scalar/IVUsersPrinter.h"
Sanjoy Das4d4339d2016-06-05 18:01:19 +0000100#include "llvm/Transforms/Scalar/IndVarSimplify.h"
Sean Silva46590d52016-06-14 00:51:09 +0000101#include "llvm/Transforms/Scalar/JumpThreading.h"
Dehao Chenf400a092016-07-12 22:42:24 +0000102#include "llvm/Transforms/Scalar/LICM.h"
Chandler Carruth3bab7e12017-01-11 09:43:56 +0000103#include "llvm/Transforms/Scalar/LoopAccessAnalysisPrinter.h"
Teresa Johnson1eca6bc2016-08-13 04:11:27 +0000104#include "llvm/Transforms/Scalar/LoopDataPrefetch.h"
Jun Bum Limc837af32016-07-14 18:28:29 +0000105#include "llvm/Transforms/Scalar/LoopDeletion.h"
Adam Nemetb2593f72016-07-18 16:29:27 +0000106#include "llvm/Transforms/Scalar/LoopDistribute.h"
Dehao Chenb9f8e292016-07-12 18:45:51 +0000107#include "llvm/Transforms/Scalar/LoopIdiomRecognize.h"
Dehao Chendcafd5e2016-07-15 16:42:11 +0000108#include "llvm/Transforms/Scalar/LoopInstSimplify.h"
Chandler Carruthbaabda92017-01-27 01:32:26 +0000109#include "llvm/Transforms/Scalar/LoopLoadElimination.h"
Chandler Carruth3bab7e12017-01-11 09:43:56 +0000110#include "llvm/Transforms/Scalar/LoopPassManager.h"
Artur Pilipenko8fb3d572017-01-25 16:00:44 +0000111#include "llvm/Transforms/Scalar/LoopPredication.h"
Justin Bognerd0d23412016-05-03 22:02:31 +0000112#include "llvm/Transforms/Scalar/LoopRotation.h"
Justin Bognerab6a5132016-05-03 21:47:32 +0000113#include "llvm/Transforms/Scalar/LoopSimplifyCFG.h"
Chandler Carruthe9b18e32017-01-20 08:42:19 +0000114#include "llvm/Transforms/Scalar/LoopSink.h"
Dehao Chen6132ee82016-07-18 21:41:50 +0000115#include "llvm/Transforms/Scalar/LoopStrengthReduce.h"
Sean Silvae3c18a52016-07-19 23:54:23 +0000116#include "llvm/Transforms/Scalar/LoopUnrollPass.h"
Davide Italiano99223442016-05-13 22:52:35 +0000117#include "llvm/Transforms/Scalar/LowerAtomic.h"
Chandler Carruth43e590e2015-01-24 11:13:02 +0000118#include "llvm/Transforms/Scalar/LowerExpectIntrinsic.h"
Michael Kupersteine45d4d92016-07-28 22:08:41 +0000119#include "llvm/Transforms/Scalar/LowerGuardIntrinsic.h"
Sean Silva6347df02016-06-14 02:44:55 +0000120#include "llvm/Transforms/Scalar/MemCpyOptimizer.h"
Davide Italianob49aa5c2016-06-17 19:10:09 +0000121#include "llvm/Transforms/Scalar/MergedLoadStoreMotion.h"
Wei Mi1cf58f82016-07-21 22:28:52 +0000122#include "llvm/Transforms/Scalar/NaryReassociate.h"
Davide Italianoe05e3302016-12-22 16:35:02 +0000123#include "llvm/Transforms/Scalar/NewGVN.h"
Davide Italiano1021c682016-05-25 23:38:53 +0000124#include "llvm/Transforms/Scalar/PartiallyInlineLibCalls.h"
Justin Bognerc2bf63d2016-04-26 23:39:29 +0000125#include "llvm/Transforms/Scalar/Reassociate.h"
Davide Italiano98f7e0e2016-05-18 15:18:25 +0000126#include "llvm/Transforms/Scalar/SCCP.h"
Chandler Carruth29a18a42015-09-12 09:09:14 +0000127#include "llvm/Transforms/Scalar/SROA.h"
Chandler Carruth1353f9a2017-04-27 18:45:20 +0000128#include "llvm/Transforms/Scalar/SimpleLoopUnswitch.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +0000129#include "llvm/Transforms/Scalar/SimplifyCFG.h"
Justin Bognerb9394902016-04-22 19:54:10 +0000130#include "llvm/Transforms/Scalar/Sink.h"
Michael Kupersteinc4061862016-08-01 21:48:33 +0000131#include "llvm/Transforms/Scalar/SpeculativeExecution.h"
Sean Silva59fe82f2016-07-06 23:48:41 +0000132#include "llvm/Transforms/Scalar/TailRecursionElimination.h"
Xinliang David Li1eaecef2016-06-15 21:51:30 +0000133#include "llvm/Transforms/Utils/AddDiscriminators.h"
Wei Mie04d0ef2016-07-22 18:04:25 +0000134#include "llvm/Transforms/Utils/BreakCriticalEdges.h"
Easwaran Ramane12c4872016-06-09 19:44:46 +0000135#include "llvm/Transforms/Utils/LCSSA.h"
Rong Xu1c0e9b92016-10-18 21:36:27 +0000136#include "llvm/Transforms/Utils/LibCallsShrinkWrap.h"
Davide Italianocd96cfd2016-07-09 03:03:01 +0000137#include "llvm/Transforms/Utils/LoopSimplify.h"
Michael Kuperstein31b83992016-08-12 17:28:27 +0000138#include "llvm/Transforms/Utils/LowerInvoke.h"
Davide Italianocccf4f02016-06-14 03:22:22 +0000139#include "llvm/Transforms/Utils/Mem2Reg.h"
Mehdi Amini27d23792016-09-16 16:56:30 +0000140#include "llvm/Transforms/Utils/NameAnonGlobals.h"
Daniel Berlin439042b2017-02-07 21:10:46 +0000141#include "llvm/Transforms/Utils/PredicateInfo.h"
Davide Italiano16284df2016-07-07 21:14:36 +0000142#include "llvm/Transforms/Utils/SimplifyInstructions.h"
Michael Kuperstein39feb622016-07-25 20:52:00 +0000143#include "llvm/Transforms/Utils/SymbolRewriter.h"
Sean Silvadb90d4d2016-07-09 22:56:50 +0000144#include "llvm/Transforms/Vectorize/LoopVectorize.h"
Sean Silva0dacbd82016-07-09 03:11:29 +0000145#include "llvm/Transforms/Vectorize/SLPVectorizer.h"
Davide Italianocccf4f02016-06-14 03:22:22 +0000146
Chandler Carruth58dde8c2016-02-26 12:17:54 +0000147#include <type_traits>
Chandler Carruth66445382014-01-11 08:16:35 +0000148
149using namespace llvm;
150
Chandler Carruth719ffe12017-02-12 05:38:04 +0000151static cl::opt<unsigned> MaxDevirtIterations("pm-max-devirt-iterations",
152 cl::ReallyHidden, cl::init(4));
Xinliang David Li126157c2017-05-22 16:41:57 +0000153static cl::opt<bool>
154 RunPartialInlining("enable-npm-partial-inlining", cl::init(false),
155 cl::Hidden, cl::ZeroOrMore,
156 cl::desc("Run Partial inlinining pass"));
Chandler Carruth719ffe12017-02-12 05:38:04 +0000157
Davide Italiano8a09b8e2017-05-22 23:41:40 +0000158static cl::opt<bool>
Davide Italiano8e7d11a2017-05-22 23:47:11 +0000159 RunNewGVN("enable-npm-newgvn", cl::init(false),
Davide Italiano8a09b8e2017-05-22 23:41:40 +0000160 cl::Hidden, cl::ZeroOrMore,
161 cl::desc("Run NewGVN instead of GVN"));
162
Geoff Berry3cca1da2017-06-10 15:20:03 +0000163static cl::opt<bool> EnableEarlyCSEMemSSA(
Geoff Berry2573a192017-06-27 22:25:02 +0000164 "enable-npm-earlycse-memssa", cl::init(true), cl::Hidden,
165 cl::desc("Enable the EarlyCSE w/ MemorySSA pass for the new PM (default = on)"));
Geoff Berry3cca1da2017-06-10 15:20:03 +0000166
Chandler Carruthc246a4c2017-04-27 00:28:03 +0000167static cl::opt<bool> EnableGVNHoist(
168 "enable-npm-gvn-hoist", cl::init(false), cl::Hidden,
169 cl::desc("Enable the GVN hoisting pass for the new PM (default = off)"));
170
Davide Italianobe1b6a92017-06-03 23:18:29 +0000171static cl::opt<bool> EnableGVNSink(
172 "enable-npm-gvn-sink", cl::init(false), cl::Hidden,
173 cl::desc("Enable the GVN hoisting pass for the new PM (default = off)"));
174
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000175static Regex DefaultAliasRegex(
176 "^(default|thinlto-pre-link|thinlto|lto-pre-link|lto)<(O[0123sz])>$");
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000177
Chandler Carruthe3f50642016-12-22 06:59:15 +0000178static bool isOptimizingForSize(PassBuilder::OptimizationLevel Level) {
179 switch (Level) {
180 case PassBuilder::O0:
181 case PassBuilder::O1:
182 case PassBuilder::O2:
183 case PassBuilder::O3:
184 return false;
185
186 case PassBuilder::Os:
187 case PassBuilder::Oz:
188 return true;
189 }
190 llvm_unreachable("Invalid optimization level!");
191}
192
Chandler Carruth66445382014-01-11 08:16:35 +0000193namespace {
194
Chandler Carruthd8330982014-01-12 09:34:22 +0000195/// \brief No-op module pass which does nothing.
Chandler Carruth66445382014-01-11 08:16:35 +0000196struct NoOpModulePass {
Sean Silvafd03ac62016-08-09 00:28:38 +0000197 PreservedAnalyses run(Module &M, ModuleAnalysisManager &) {
Chandler Carruth164a2aa62016-06-17 00:11:01 +0000198 return PreservedAnalyses::all();
199 }
Chandler Carrutha13f27c2014-01-11 11:52:05 +0000200 static StringRef name() { return "NoOpModulePass"; }
Chandler Carruth66445382014-01-11 08:16:35 +0000201};
202
Chandler Carruth0b576b32015-01-06 02:50:06 +0000203/// \brief No-op module analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000204class NoOpModuleAnalysis : public AnalysisInfoMixin<NoOpModuleAnalysis> {
205 friend AnalysisInfoMixin<NoOpModuleAnalysis>;
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000206 static AnalysisKey Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000207
208public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000209 struct Result {};
Sean Silvafd03ac62016-08-09 00:28:38 +0000210 Result run(Module &, ModuleAnalysisManager &) { return Result(); }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000211 static StringRef name() { return "NoOpModuleAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000212};
213
Chandler Carruth572e3402014-04-21 11:12:00 +0000214/// \brief No-op CGSCC pass which does nothing.
215struct NoOpCGSCCPass {
Chandler Carruth88823462016-08-24 09:37:14 +0000216 PreservedAnalyses run(LazyCallGraph::SCC &C, CGSCCAnalysisManager &,
217 LazyCallGraph &, CGSCCUpdateResult &UR) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000218 return PreservedAnalyses::all();
219 }
220 static StringRef name() { return "NoOpCGSCCPass"; }
221};
222
Chandler Carruth0b576b32015-01-06 02:50:06 +0000223/// \brief No-op CGSCC analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000224class NoOpCGSCCAnalysis : public AnalysisInfoMixin<NoOpCGSCCAnalysis> {
225 friend AnalysisInfoMixin<NoOpCGSCCAnalysis>;
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000226 static AnalysisKey Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000227
228public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000229 struct Result {};
Chandler Carruth88823462016-08-24 09:37:14 +0000230 Result run(LazyCallGraph::SCC &, CGSCCAnalysisManager &, LazyCallGraph &G) {
Chandler Carruth164a2aa62016-06-17 00:11:01 +0000231 return Result();
232 }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000233 static StringRef name() { return "NoOpCGSCCAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000234};
235
Chandler Carruthd8330982014-01-12 09:34:22 +0000236/// \brief No-op function pass which does nothing.
237struct NoOpFunctionPass {
Sean Silva36e0d012016-08-09 00:28:15 +0000238 PreservedAnalyses run(Function &F, FunctionAnalysisManager &) {
Chandler Carruth164a2aa62016-06-17 00:11:01 +0000239 return PreservedAnalyses::all();
240 }
Chandler Carruthd8330982014-01-12 09:34:22 +0000241 static StringRef name() { return "NoOpFunctionPass"; }
242};
243
Chandler Carruth0b576b32015-01-06 02:50:06 +0000244/// \brief No-op function analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000245class NoOpFunctionAnalysis : public AnalysisInfoMixin<NoOpFunctionAnalysis> {
246 friend AnalysisInfoMixin<NoOpFunctionAnalysis>;
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000247 static AnalysisKey Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000248
249public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000250 struct Result {};
Sean Silva36e0d012016-08-09 00:28:15 +0000251 Result run(Function &, FunctionAnalysisManager &) { return Result(); }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000252 static StringRef name() { return "NoOpFunctionAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000253};
254
Justin Bognereecc3c82016-02-25 07:23:08 +0000255/// \brief No-op loop pass which does nothing.
256struct NoOpLoopPass {
Chandler Carruth410eaeb2017-01-11 06:23:21 +0000257 PreservedAnalyses run(Loop &L, LoopAnalysisManager &,
258 LoopStandardAnalysisResults &, LPMUpdater &) {
Chandler Carruth164a2aa62016-06-17 00:11:01 +0000259 return PreservedAnalyses::all();
260 }
Justin Bognereecc3c82016-02-25 07:23:08 +0000261 static StringRef name() { return "NoOpLoopPass"; }
262};
263
264/// \brief No-op loop analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000265class NoOpLoopAnalysis : public AnalysisInfoMixin<NoOpLoopAnalysis> {
266 friend AnalysisInfoMixin<NoOpLoopAnalysis>;
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000267 static AnalysisKey Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000268
269public:
Justin Bognereecc3c82016-02-25 07:23:08 +0000270 struct Result {};
Chandler Carruth410eaeb2017-01-11 06:23:21 +0000271 Result run(Loop &, LoopAnalysisManager &, LoopStandardAnalysisResults &) {
272 return Result();
273 }
Justin Bognereecc3c82016-02-25 07:23:08 +0000274 static StringRef name() { return "NoOpLoopAnalysis"; }
Justin Bognereecc3c82016-02-25 07:23:08 +0000275};
276
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000277AnalysisKey NoOpModuleAnalysis::Key;
278AnalysisKey NoOpCGSCCAnalysis::Key;
279AnalysisKey NoOpFunctionAnalysis::Key;
280AnalysisKey NoOpLoopAnalysis::Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000281
Chandler Carruth66445382014-01-11 08:16:35 +0000282} // End anonymous namespace.
283
Chandler Carruth1ff77242015-03-07 09:02:36 +0000284void PassBuilder::registerModuleAnalyses(ModuleAnalysisManager &MAM) {
Chandler Carruth74a8a222016-06-17 07:15:29 +0000285#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000286 MAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000287#include "PassRegistry.def"
288}
289
Chandler Carruth1ff77242015-03-07 09:02:36 +0000290void PassBuilder::registerCGSCCAnalyses(CGSCCAnalysisManager &CGAM) {
Chandler Carruth74a8a222016-06-17 07:15:29 +0000291#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000292 CGAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000293#include "PassRegistry.def"
294}
295
Chandler Carruth1ff77242015-03-07 09:02:36 +0000296void PassBuilder::registerFunctionAnalyses(FunctionAnalysisManager &FAM) {
Chandler Carruth74a8a222016-06-17 07:15:29 +0000297#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000298 FAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000299#include "PassRegistry.def"
300}
301
Justin Bognereecc3c82016-02-25 07:23:08 +0000302void PassBuilder::registerLoopAnalyses(LoopAnalysisManager &LAM) {
Chandler Carruth74a8a222016-06-17 07:15:29 +0000303#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
Justin Bognereecc3c82016-02-25 07:23:08 +0000304 LAM.registerPass([&] { return CREATE_PASS; });
305#include "PassRegistry.def"
306}
307
Chandler Carruthe3f50642016-12-22 06:59:15 +0000308FunctionPassManager
309PassBuilder::buildFunctionSimplificationPipeline(OptimizationLevel Level,
310 bool DebugLogging) {
311 assert(Level != O0 && "Must request optimizations!");
312 FunctionPassManager FPM(DebugLogging);
313
314 // Form SSA out of local memory accesses after breaking apart aggregates into
315 // scalars.
316 FPM.addPass(SROA());
317
318 // Catch trivial redundancies
Geoff Berry3cca1da2017-06-10 15:20:03 +0000319 FPM.addPass(EarlyCSEPass(EnableEarlyCSEMemSSA));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000320
Davide Italianoc3688312017-06-01 23:08:14 +0000321 // Hoisting of scalars and load expressions.
322 if (EnableGVNHoist)
323 FPM.addPass(GVNHoistPass());
324
Davide Italianobe1b6a92017-06-03 23:18:29 +0000325 // Global value numbering based sinking.
326 if (EnableGVNSink) {
327 FPM.addPass(GVNSinkPass());
328 FPM.addPass(SimplifyCFGPass());
329 }
330
Chandler Carruthe3f50642016-12-22 06:59:15 +0000331 // Speculative execution if the target has divergent branches; otherwise nop.
332 FPM.addPass(SpeculativeExecutionPass());
333
334 // Optimize based on known information about branches, and cleanup afterward.
335 FPM.addPass(JumpThreadingPass());
336 FPM.addPass(CorrelatedValuePropagationPass());
337 FPM.addPass(SimplifyCFGPass());
338 FPM.addPass(InstCombinePass());
339
340 if (!isOptimizingForSize(Level))
341 FPM.addPass(LibCallsShrinkWrapPass());
342
343 FPM.addPass(TailCallElimPass());
344 FPM.addPass(SimplifyCFGPass());
345
346 // Form canonically associated expression trees, and simplify the trees using
347 // basic mathematical properties. For example, this will form (nearly)
348 // minimal multiplication trees.
349 FPM.addPass(ReassociatePass());
350
351 // Add the primary loop simplification pipeline.
352 // FIXME: Currently this is split into two loop pass pipelines because we run
353 // some function passes in between them. These can and should be replaced by
354 // loop pass equivalenst but those aren't ready yet. Specifically,
355 // `SimplifyCFGPass` and `InstCombinePass` are used. We have
356 // `LoopSimplifyCFGPass` which isn't yet powerful enough, and the closest to
357 // the other we have is `LoopInstSimplify`.
358 LoopPassManager LPM1(DebugLogging), LPM2(DebugLogging);
359
360 // Rotate Loop - disable header duplication at -Oz
361 LPM1.addPass(LoopRotatePass(Level != Oz));
362 LPM1.addPass(LICMPass());
Chandler Carruth86248d52017-05-26 01:24:11 +0000363 LPM1.addPass(SimpleLoopUnswitchPass());
Chandler Carruth79b733b2017-01-26 23:21:17 +0000364 LPM2.addPass(IndVarSimplifyPass());
365 LPM2.addPass(LoopIdiomRecognizePass());
366 LPM2.addPass(LoopDeletionPass());
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000367 // FIXME: The old pass manager has a hack to disable loop unrolling during
368 // ThinLTO when using sample PGO. Need to either fix it or port some
369 // workaround.
Dehao Chen7d230322017-02-18 03:46:51 +0000370 LPM2.addPass(LoopUnrollPass::createFull(Level));
Chandler Carruth79b733b2017-01-26 23:21:17 +0000371
Chandler Carruth0ede22e2017-02-09 23:54:57 +0000372 // We provide the opt remark emitter pass for LICM to use. We only need to do
373 // this once as it is immutable.
374 FPM.addPass(RequireAnalysisPass<OptimizationRemarkEmitterAnalysis, Function>());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000375 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM1)));
376 FPM.addPass(SimplifyCFGPass());
377 FPM.addPass(InstCombinePass());
378 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM2)));
379
380 // Eliminate redundancies.
381 if (Level != O1) {
382 // These passes add substantial compile time so skip them at O1.
383 FPM.addPass(MergedLoadStoreMotionPass());
Davide Italiano8a09b8e2017-05-22 23:41:40 +0000384 if (RunNewGVN)
385 FPM.addPass(NewGVNPass());
386 else
387 FPM.addPass(GVN());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000388 }
389
390 // Specially optimize memory movement as it doesn't look like dataflow in SSA.
391 FPM.addPass(MemCpyOptPass());
392
393 // Sparse conditional constant propagation.
394 // FIXME: It isn't clear why we do this *after* loop passes rather than
395 // before...
396 FPM.addPass(SCCPPass());
397
398 // Delete dead bit computations (instcombine runs after to fold away the dead
399 // computations, and then ADCE will run later to exploit any new DCE
400 // opportunities that creates).
401 FPM.addPass(BDCEPass());
402
403 // Run instcombine after redundancy and dead bit elimination to exploit
404 // opportunities opened up by them.
405 FPM.addPass(InstCombinePass());
406
407 // Re-consider control flow based optimizations after redundancy elimination,
408 // redo DCE, etc.
409 FPM.addPass(JumpThreadingPass());
410 FPM.addPass(CorrelatedValuePropagationPass());
411 FPM.addPass(DSEPass());
412 FPM.addPass(createFunctionToLoopPassAdaptor(LICMPass()));
413
414 // Finally, do an expensive DCE pass to catch all the dead code exposed by
415 // the simplifications and basic cleanup after all the simplifications.
416 FPM.addPass(ADCEPass());
417 FPM.addPass(SimplifyCFGPass());
418 FPM.addPass(InstCombinePass());
419
420 return FPM;
421}
422
Davide Italiano513dfaa2017-02-13 15:26:22 +0000423static void addPGOInstrPasses(ModulePassManager &MPM, bool DebugLogging,
424 PassBuilder::OptimizationLevel Level,
425 bool RunProfileGen, std::string ProfileGenFile,
426 std::string ProfileUseFile) {
427 // Generally running simplification passes and the inliner with an high
428 // threshold results in smaller executables, but there may be cases where
429 // the size grows, so let's be conservative here and skip this simplification
430 // at -Os/Oz.
431 if (!isOptimizingForSize(Level)) {
432 InlineParams IP;
433
434 // In the old pass manager, this is a cl::opt. Should still this be one?
435 IP.DefaultThreshold = 75;
436
437 // FIXME: The hint threshold has the same value used by the regular inliner.
438 // This should probably be lowered after performance testing.
439 // FIXME: this comment is cargo culted from the old pass manager, revisit).
440 IP.HintThreshold = 325;
441
442 CGSCCPassManager CGPipeline(DebugLogging);
443
444 CGPipeline.addPass(InlinerPass(IP));
445
446 FunctionPassManager FPM;
447 FPM.addPass(SROA());
448 FPM.addPass(EarlyCSEPass()); // Catch trivial redundancies.
449 FPM.addPass(SimplifyCFGPass()); // Merge & remove basic blocks.
450 FPM.addPass(InstCombinePass()); // Combine silly sequences.
451
452 // FIXME: Here the old pass manager inserts peephole extensions.
453 // Add them when they're supported.
454 CGPipeline.addPass(createCGSCCToFunctionPassAdaptor(std::move(FPM)));
455
456 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPipeline)));
457 }
458
Chandler Carruthf4d62c42017-05-25 07:15:09 +0000459 // Delete anything that is now dead to make sure that we don't instrument
460 // dead code. Instrumentation can end up keeping dead code around and
461 // dramatically increase code size.
462 MPM.addPass(GlobalDCEPass());
463
Davide Italiano513dfaa2017-02-13 15:26:22 +0000464 if (RunProfileGen) {
465 MPM.addPass(PGOInstrumentationGen());
466
Xinliang David Lib67530e2017-06-25 00:26:43 +0000467 FunctionPassManager FPM;
468 FPM.addPass(createFunctionToLoopPassAdaptor(LoopRotatePass()));
469 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
470
Davide Italiano513dfaa2017-02-13 15:26:22 +0000471 // Add the profile lowering pass.
472 InstrProfOptions Options;
473 if (!ProfileGenFile.empty())
474 Options.InstrProfileOutput = ProfileGenFile;
Xinliang David Lib67530e2017-06-25 00:26:43 +0000475 Options.DoCounterPromotion = true;
Davide Italiano513dfaa2017-02-13 15:26:22 +0000476 MPM.addPass(InstrProfiling(Options));
477 }
478
479 if (!ProfileUseFile.empty())
480 MPM.addPass(PGOInstrumentationUse(ProfileUseFile));
481}
482
Easwaran Raman8249fac2017-06-28 13:33:49 +0000483static InlineParams
484getInlineParamsFromOptLevel(PassBuilder::OptimizationLevel Level) {
485 auto O3 = PassBuilder::O3;
486 unsigned OptLevel = Level > O3 ? 2 : Level;
487 unsigned SizeLevel = Level > O3 ? Level - O3 : 0;
488 return getInlineParams(OptLevel, SizeLevel);
489}
490
Chandler Carruthe3f50642016-12-22 06:59:15 +0000491ModulePassManager
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000492PassBuilder::buildModuleSimplificationPipeline(OptimizationLevel Level,
493 bool DebugLogging) {
Chandler Carruthe3f50642016-12-22 06:59:15 +0000494 ModulePassManager MPM(DebugLogging);
495
Chandler Carruthe3f50642016-12-22 06:59:15 +0000496 // Do basic inference of function attributes from known properties of system
497 // libraries and other oracles.
498 MPM.addPass(InferFunctionAttrsPass());
499
500 // Create an early function pass manager to cleanup the output of the
501 // frontend.
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000502 FunctionPassManager EarlyFPM(DebugLogging);
503 EarlyFPM.addPass(SimplifyCFGPass());
504 EarlyFPM.addPass(SROA());
505 EarlyFPM.addPass(EarlyCSEPass());
506 EarlyFPM.addPass(LowerExpectIntrinsicPass());
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000507 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(EarlyFPM)));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000508
509 // Interprocedural constant propagation now that basic cleanup has occured
510 // and prior to optimizing globals.
511 // FIXME: This position in the pipeline hasn't been carefully considered in
512 // years, it should be re-analyzed.
513 MPM.addPass(IPSCCPPass());
514
515 // Optimize globals to try and fold them into constants.
516 MPM.addPass(GlobalOptPass());
517
518 // Promote any localized globals to SSA registers.
519 // FIXME: Should this instead by a run of SROA?
520 // FIXME: We should probably run instcombine and simplify-cfg afterward to
521 // delete control flows that are dead once globals have been folded to
522 // constants.
523 MPM.addPass(createModuleToFunctionPassAdaptor(PromotePass()));
524
525 // Remove any dead arguments exposed by cleanups and constand folding
526 // globals.
527 MPM.addPass(DeadArgumentEliminationPass());
528
529 // Create a small function pass pipeline to cleanup after all the global
530 // optimizations.
531 FunctionPassManager GlobalCleanupPM(DebugLogging);
532 GlobalCleanupPM.addPass(InstCombinePass());
533 GlobalCleanupPM.addPass(SimplifyCFGPass());
534 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(GlobalCleanupPM)));
535
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000536 // Add all the requested passes for PGO, if requested.
Davide Italiano513dfaa2017-02-13 15:26:22 +0000537 if (PGOOpt) {
Dehao Chen2f31d0d2017-06-29 23:33:05 +0000538 assert(PGOOpt->RunProfileGen || !PGOOpt->SampleProfileFile.empty() ||
Dehao Chencc75d242017-02-23 22:15:18 +0000539 !PGOOpt->ProfileUseFile.empty());
Dehao Chen2f31d0d2017-06-29 23:33:05 +0000540 if (PGOOpt->SampleProfileFile.empty())
541 addPGOInstrPasses(MPM, DebugLogging, Level, PGOOpt->RunProfileGen,
542 PGOOpt->ProfileGenFile, PGOOpt->ProfileUseFile);
543 else
544 MPM.addPass(SampleProfileLoaderPass(PGOOpt->SampleProfileFile));
Davide Italiano513dfaa2017-02-13 15:26:22 +0000545
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000546 // Indirect call promotion that promotes intra-module targes only.
Dehao Chen2f31d0d2017-06-29 23:33:05 +0000547 MPM.addPass(PGOIndirectCallPromotion(
548 false, PGOOpt && !PGOOpt->SampleProfileFile.empty()));
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000549 }
Davide Italiano513dfaa2017-02-13 15:26:22 +0000550
Chandler Carruthe87fc8c2017-02-12 05:34:04 +0000551 // Require the GlobalsAA analysis for the module so we can query it within
552 // the CGSCC pipeline.
553 MPM.addPass(RequireAnalysisPass<GlobalsAA, Module>());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000554
Easwaran Raman5e6f9bd2017-05-04 16:58:45 +0000555 // Require the ProfileSummaryAnalysis for the module so we can query it within
556 // the inliner pass.
557 MPM.addPass(RequireAnalysisPass<ProfileSummaryAnalysis, Module>());
558
Chandler Carruthe3f50642016-12-22 06:59:15 +0000559 // Now begin the main postorder CGSCC pipeline.
560 // FIXME: The current CGSCC pipeline has its origins in the legacy pass
561 // manager and trying to emulate its precise behavior. Much of this doesn't
562 // make a lot of sense and we should revisit the core CGSCC structure.
563 CGSCCPassManager MainCGPipeline(DebugLogging);
564
565 // Note: historically, the PruneEH pass was run first to deduce nounwind and
566 // generally clean up exception handling overhead. It isn't clear this is
567 // valuable as the inliner doesn't currently care whether it is inlining an
568 // invoke or a call.
569
570 // Run the inliner first. The theory is that we are walking bottom-up and so
571 // the callees have already been fully optimized, and we want to inline them
572 // into the callers so that our optimizations can reflect that.
Easwaran Raman8249fac2017-06-28 13:33:49 +0000573 MainCGPipeline.addPass(InlinerPass(getInlineParamsFromOptLevel(Level)));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000574
575 // Now deduce any function attributes based in the current code.
576 MainCGPipeline.addPass(PostOrderFunctionAttrsPass());
577
Chandler Carruth0ede22e2017-02-09 23:54:57 +0000578 // When at O3 add argument promotion to the pass pipeline.
579 // FIXME: It isn't at all clear why this should be limited to O3.
580 if (Level == O3)
581 MainCGPipeline.addPass(ArgumentPromotionPass());
582
Chandler Carruthe3f50642016-12-22 06:59:15 +0000583 // Lastly, add the core function simplification pipeline nested inside the
584 // CGSCC walk.
585 MainCGPipeline.addPass(createCGSCCToFunctionPassAdaptor(
586 buildFunctionSimplificationPipeline(Level, DebugLogging)));
587
Chandler Carruth719ffe12017-02-12 05:38:04 +0000588 // We wrap the CGSCC pipeline in a devirtualization repeater. This will try
589 // to detect when we devirtualize indirect calls and iterate the SCC passes
590 // in that case to try and catch knock-on inlining or function attrs
591 // opportunities. Then we add it to the module pipeline by walking the SCCs
592 // in postorder (or bottom-up).
Chandler Carruthe3f50642016-12-22 06:59:15 +0000593 MPM.addPass(
Chandler Carruth719ffe12017-02-12 05:38:04 +0000594 createModuleToPostOrderCGSCCPassAdaptor(createDevirtSCCRepeatedPass(
595 std::move(MainCGPipeline), MaxDevirtIterations, DebugLogging)));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000596
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000597 return MPM;
598}
599
600ModulePassManager
601PassBuilder::buildModuleOptimizationPipeline(OptimizationLevel Level,
602 bool DebugLogging) {
603 ModulePassManager MPM(DebugLogging);
604
605 // Optimize globals now that the module is fully simplified.
606 MPM.addPass(GlobalOptPass());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000607
Xinliang David Li126157c2017-05-22 16:41:57 +0000608 // Run partial inlining pass to partially inline functions that have
609 // large bodies.
610 if (RunPartialInlining)
611 MPM.addPass(PartialInlinerPass());
612
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000613 // Remove avail extern fns and globals definitions since we aren't compiling
614 // an object file for later LTO. For LTO we want to preserve these so they
615 // are eligible for inlining at link-time. Note if they are unreferenced they
616 // will be removed by GlobalDCE later, so this only impacts referenced
617 // available externally globals. Eventually they will be suppressed during
618 // codegen, but eliminating here enables more opportunity for GlobalDCE as it
619 // may make globals referenced by available external functions dead and saves
620 // running remaining passes on the eliminated functions.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000621 MPM.addPass(EliminateAvailableExternallyPass());
622
623 // Do RPO function attribute inference across the module to forward-propagate
624 // attributes where applicable.
625 // FIXME: Is this really an optimization rather than a canonicalization?
626 MPM.addPass(ReversePostOrderFunctionAttrsPass());
627
Chandler Carruthe87fc8c2017-02-12 05:34:04 +0000628 // Re-require GloblasAA here prior to function passes. This is particularly
Chandler Carruthe3f50642016-12-22 06:59:15 +0000629 // useful as the above will have inlined, DCE'ed, and function-attr
630 // propagated everything. We should at this point have a reasonably minimal
631 // and richly annotated call graph. By computing aliasing and mod/ref
632 // information for all local globals here, the late loop passes and notably
633 // the vectorizer will be able to use them to help recognize vectorizable
634 // memory operations.
Chandler Carruthe87fc8c2017-02-12 05:34:04 +0000635 MPM.addPass(RequireAnalysisPass<GlobalsAA, Module>());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000636
637 FunctionPassManager OptimizePM(DebugLogging);
638 OptimizePM.addPass(Float2IntPass());
639 // FIXME: We need to run some loop optimizations to re-rotate loops after
640 // simplify-cfg and others undo their rotation.
641
642 // Optimize the loop execution. These passes operate on entire loop nests
643 // rather than on each loop in an inside-out manner, and so they are actually
644 // function passes.
Chandler Carrutha95ff382017-01-27 00:50:21 +0000645
646 // First rotate loops that may have been un-rotated by prior passes.
647 OptimizePM.addPass(createFunctionToLoopPassAdaptor(LoopRotatePass()));
648
649 // Distribute loops to allow partial vectorization. I.e. isolate dependences
650 // into separate loop that would otherwise inhibit vectorization. This is
651 // currently only performed for loops marked with the metadata
652 // llvm.loop.distribute=true or when -enable-loop-distribute is specified.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000653 OptimizePM.addPass(LoopDistributePass());
Chandler Carrutha95ff382017-01-27 00:50:21 +0000654
655 // Now run the core loop vectorizer.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000656 OptimizePM.addPass(LoopVectorizePass());
Chandler Carrutha95ff382017-01-27 00:50:21 +0000657
Chandler Carruthbaabda92017-01-27 01:32:26 +0000658 // Eliminate loads by forwarding stores from the previous iteration to loads
659 // of the current iteration.
660 OptimizePM.addPass(LoopLoadEliminationPass());
Chandler Carrutha95ff382017-01-27 00:50:21 +0000661
662 // Cleanup after the loop optimization passes.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000663 OptimizePM.addPass(InstCombinePass());
664
Chandler Carrutha95ff382017-01-27 00:50:21 +0000665
666 // Now that we've formed fast to execute loop structures, we do further
667 // optimizations. These are run afterward as they might block doing complex
668 // analyses and transforms such as what are needed for loop vectorization.
669
Chandler Carruthe3f50642016-12-22 06:59:15 +0000670 // Optimize parallel scalar instruction chains into SIMD instructions.
671 OptimizePM.addPass(SLPVectorizerPass());
672
Chandler Carrutha95ff382017-01-27 00:50:21 +0000673 // Cleanup after all of the vectorizers.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000674 OptimizePM.addPass(SimplifyCFGPass());
675 OptimizePM.addPass(InstCombinePass());
676
677 // Unroll small loops to hide loop backedge latency and saturate any parallel
Chandler Carrutha95ff382017-01-27 00:50:21 +0000678 // execution resources of an out-of-order processor. We also then need to
679 // clean up redundancies and loop invariant code.
680 // FIXME: It would be really good to use a loop-integrated instruction
681 // combiner for cleanup here so that the unrolling and LICM can be pipelined
682 // across the loop nests.
Dehao Chen7d230322017-02-18 03:46:51 +0000683 OptimizePM.addPass(createFunctionToLoopPassAdaptor(LoopUnrollPass::create(Level)));
Chandler Carrutha95ff382017-01-27 00:50:21 +0000684 OptimizePM.addPass(InstCombinePass());
Chandler Carruth0ede22e2017-02-09 23:54:57 +0000685 OptimizePM.addPass(RequireAnalysisPass<OptimizationRemarkEmitterAnalysis, Function>());
Chandler Carrutha95ff382017-01-27 00:50:21 +0000686 OptimizePM.addPass(createFunctionToLoopPassAdaptor(LICMPass()));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000687
688 // Now that we've vectorized and unrolled loops, we may have more refined
689 // alignment information, try to re-derive it here.
690 OptimizePM.addPass(AlignmentFromAssumptionsPass());
691
Chandler Carrutha95ff382017-01-27 00:50:21 +0000692 // LoopSink pass sinks instructions hoisted by LICM, which serves as a
693 // canonicalization pass that enables other optimizations. As a result,
694 // LoopSink pass needs to be a very late IR pass to avoid undoing LICM
695 // result too early.
696 OptimizePM.addPass(LoopSinkPass());
697
698 // And finally clean up LCSSA form before generating code.
699 OptimizePM.addPass(InstSimplifierPass());
700
Filipe Cabecinhas92dc3482017-04-26 12:02:41 +0000701 // LoopSink (and other loop passes since the last simplifyCFG) might have
702 // resulted in single-entry-single-exit or empty blocks. Clean up the CFG.
703 OptimizePM.addPass(SimplifyCFGPass());
704
Chandler Carrutha95ff382017-01-27 00:50:21 +0000705 // Add the core optimizing pipeline.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000706 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(OptimizePM)));
707
708 // Now we need to do some global optimization transforms.
709 // FIXME: It would seem like these should come first in the optimization
710 // pipeline and maybe be the bottom of the canonicalization pipeline? Weird
711 // ordering here.
712 MPM.addPass(GlobalDCEPass());
713 MPM.addPass(ConstantMergePass());
714
715 return MPM;
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000716}
717
Chandler Carruthe3f50642016-12-22 06:59:15 +0000718ModulePassManager
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000719PassBuilder::buildPerModuleDefaultPipeline(OptimizationLevel Level,
720 bool DebugLogging) {
721 assert(Level != O0 && "Must request optimizations for the default pipeline!");
722
723 ModulePassManager MPM(DebugLogging);
724
725 // Force any function attributes we want the rest of the pipeline to observe.
726 MPM.addPass(ForceFunctionAttrsPass());
727
728 // Add the core simplification pipeline.
729 MPM.addPass(buildModuleSimplificationPipeline(Level, DebugLogging));
730
731 // Now add the optimization pipeline.
732 MPM.addPass(buildModuleOptimizationPipeline(Level, DebugLogging));
733
734 return MPM;
735}
736
737ModulePassManager
738PassBuilder::buildThinLTOPreLinkDefaultPipeline(OptimizationLevel Level,
739 bool DebugLogging) {
740 assert(Level != O0 && "Must request optimizations for the default pipeline!");
741
742 ModulePassManager MPM(DebugLogging);
743
744 // Force any function attributes we want the rest of the pipeline to observe.
745 MPM.addPass(ForceFunctionAttrsPass());
746
747 // If we are planning to perform ThinLTO later, we don't bloat the code with
748 // unrolling/vectorization/... now. Just simplify the module as much as we
749 // can.
750 MPM.addPass(buildModuleSimplificationPipeline(Level, DebugLogging));
751
752 // Run partial inlining pass to partially inline functions that have
753 // large bodies.
754 // FIXME: It isn't clear whether this is really the right place to run this
755 // in ThinLTO. Because there is another canonicalization and simplification
756 // phase that will run after the thin link, running this here ends up with
757 // less information than will be available later and it may grow functions in
758 // ways that aren't beneficial.
759 if (RunPartialInlining)
760 MPM.addPass(PartialInlinerPass());
761
762 // Reduce the size of the IR as much as possible.
763 MPM.addPass(GlobalOptPass());
764
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000765 return MPM;
766}
767
768ModulePassManager
769PassBuilder::buildThinLTODefaultPipeline(OptimizationLevel Level,
770 bool DebugLogging) {
771 // FIXME: The summary index is not hooked in the new pass manager yet.
772 // When it's going to be hooked, enable WholeProgramDevirt and LowerTypeTest
773 // here.
774
775 ModulePassManager MPM(DebugLogging);
776
777 // Force any function attributes we want the rest of the pipeline to observe.
778 MPM.addPass(ForceFunctionAttrsPass());
779
780 // During the ThinLTO backend phase we perform early indirect call promotion
781 // here, before globalopt. Otherwise imported available_externally functions
782 // look unreferenced and are removed.
Dehao Chen2f31d0d2017-06-29 23:33:05 +0000783 MPM.addPass(PGOIndirectCallPromotion(
784 true /* InLTO */, PGOOpt && !PGOOpt->SampleProfileFile.empty() &&
785 !PGOOpt->ProfileUseFile.empty()));
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000786
787 // Add the core simplification pipeline.
788 MPM.addPass(buildModuleSimplificationPipeline(Level, DebugLogging));
789
790 // Now add the optimization pipeline.
791 MPM.addPass(buildModuleOptimizationPipeline(Level, DebugLogging));
792
793 return MPM;
794}
795
796ModulePassManager
Chandler Carruthe3f50642016-12-22 06:59:15 +0000797PassBuilder::buildLTOPreLinkDefaultPipeline(OptimizationLevel Level,
798 bool DebugLogging) {
799 assert(Level != O0 && "Must request optimizations for the default pipeline!");
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000800 // FIXME: We should use a customized pre-link pipeline!
Chandler Carruthe3f50642016-12-22 06:59:15 +0000801 return buildPerModuleDefaultPipeline(Level, DebugLogging);
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000802}
803
Chandler Carruthe3f50642016-12-22 06:59:15 +0000804ModulePassManager PassBuilder::buildLTODefaultPipeline(OptimizationLevel Level,
805 bool DebugLogging) {
806 assert(Level != O0 && "Must request optimizations for the default pipeline!");
807 ModulePassManager MPM(DebugLogging);
808
Davide Italiano089a9122017-01-24 00:57:39 +0000809 // Remove unused virtual tables to improve the quality of code generated by
810 // whole-program devirtualization and bitset lowering.
811 MPM.addPass(GlobalDCEPass());
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000812
Davide Italiano089a9122017-01-24 00:57:39 +0000813 // Force any function attributes we want the rest of the pipeline to observe.
814 MPM.addPass(ForceFunctionAttrsPass());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000815
Davide Italiano089a9122017-01-24 00:57:39 +0000816 // Do basic inference of function attributes from known properties of system
817 // libraries and other oracles.
818 MPM.addPass(InferFunctionAttrsPass());
819
820 if (Level > 1) {
821 // Indirect call promotion. This should promote all the targets that are
822 // left by the earlier promotion pass that promotes intra-module targets.
823 // This two-step promotion is to save the compile time. For LTO, it should
824 // produce the same result as if we only do promotion here.
Dehao Chen2f31d0d2017-06-29 23:33:05 +0000825 MPM.addPass(PGOIndirectCallPromotion(
826 true /* InLTO */, PGOOpt && !PGOOpt->SampleProfileFile.empty()));
Davide Italiano089a9122017-01-24 00:57:39 +0000827
828 // Propagate constants at call sites into the functions they call. This
829 // opens opportunities for globalopt (and inlining) by substituting function
830 // pointers passed as arguments to direct uses of functions.
831 MPM.addPass(IPSCCPPass());
832 }
833
834 // Now deduce any function attributes based in the current code.
835 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(
836 PostOrderFunctionAttrsPass()));
837
838 // Do RPO function attribute inference across the module to forward-propagate
839 // attributes where applicable.
840 // FIXME: Is this really an optimization rather than a canonicalization?
841 MPM.addPass(ReversePostOrderFunctionAttrsPass());
842
843 // Use inragne annotations on GEP indices to split globals where beneficial.
844 MPM.addPass(GlobalSplitPass());
845
846 // Run whole program optimization of virtual call when the list of callees
847 // is fixed.
848 MPM.addPass(WholeProgramDevirtPass());
849
850 // Stop here at -O1.
851 if (Level == 1)
852 return MPM;
853
854 // Optimize globals to try and fold them into constants.
855 MPM.addPass(GlobalOptPass());
856
857 // Promote any localized globals to SSA registers.
858 MPM.addPass(createModuleToFunctionPassAdaptor(PromotePass()));
859
860 // Linking modules together can lead to duplicate global constant, only
861 // keep one copy of each constant.
862 MPM.addPass(ConstantMergePass());
863
864 // Remove unused arguments from functions.
865 MPM.addPass(DeadArgumentEliminationPass());
866
867 // Reduce the code after globalopt and ipsccp. Both can open up significant
868 // simplification opportunities, and both can propagate functions through
869 // function pointers. When this happens, we often have to resolve varargs
870 // calls, etc, so let instcombine do this.
871 // FIXME: add peephole extensions here as the legacy PM does.
872 MPM.addPass(createModuleToFunctionPassAdaptor(InstCombinePass()));
873
874 // Note: historically, the PruneEH pass was run first to deduce nounwind and
875 // generally clean up exception handling overhead. It isn't clear this is
876 // valuable as the inliner doesn't currently care whether it is inlining an
877 // invoke or a call.
878 // Run the inliner now.
Easwaran Raman8249fac2017-06-28 13:33:49 +0000879 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(
880 InlinerPass(getInlineParamsFromOptLevel(Level))));
Davide Italiano089a9122017-01-24 00:57:39 +0000881
882 // Optimize globals again after we ran the inliner.
883 MPM.addPass(GlobalOptPass());
884
885 // Garbage collect dead functions.
886 // FIXME: Add ArgumentPromotion pass after once it's ported.
887 MPM.addPass(GlobalDCEPass());
888
889 FunctionPassManager FPM(DebugLogging);
890
891 // The IPO Passes may leave cruft around. Clean up after them.
892 // FIXME: add peephole extensions here as the legacy PM does.
893 FPM.addPass(InstCombinePass());
894 FPM.addPass(JumpThreadingPass());
895
896 // Break up allocas
897 FPM.addPass(SROA());
898
899 // Run a few AA driver optimizations here and now to cleanup the code.
900 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
901
902 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(
903 PostOrderFunctionAttrsPass()));
904 // FIXME: here we run IP alias analysis in the legacy PM.
905
906 FunctionPassManager MainFPM;
907
908 // FIXME: once we fix LoopPass Manager, add LICM here.
909 // FIXME: once we provide support for enabling MLSM, add it here.
910 // FIXME: once we provide support for enabling NewGVN, add it here.
Davide Italiano8a09b8e2017-05-22 23:41:40 +0000911 if (RunNewGVN)
912 MainFPM.addPass(NewGVNPass());
913 else
914 MainFPM.addPass(GVN());
Davide Italiano089a9122017-01-24 00:57:39 +0000915
916 // Remove dead memcpy()'s.
917 MainFPM.addPass(MemCpyOptPass());
918
919 // Nuke dead stores.
920 MainFPM.addPass(DSEPass());
921
922 // FIXME: at this point, we run a bunch of loop passes:
923 // indVarSimplify, loopDeletion, loopInterchange, loopUnrool,
924 // loopVectorize. Enable them once the remaining issue with LPM
925 // are sorted out.
926
927 MainFPM.addPass(InstCombinePass());
928 MainFPM.addPass(SimplifyCFGPass());
929 MainFPM.addPass(SCCPPass());
930 MainFPM.addPass(InstCombinePass());
931 MainFPM.addPass(BDCEPass());
932
933 // FIXME: We may want to run SLPVectorizer here.
934 // After vectorization, assume intrinsics may tell us more
935 // about pointer alignments.
936#if 0
937 MainFPM.add(AlignmentFromAssumptionsPass());
938#endif
939
Davide Italiano089a9122017-01-24 00:57:39 +0000940 // FIXME: add peephole extensions to the PM here.
941 MainFPM.addPass(InstCombinePass());
942 MainFPM.addPass(JumpThreadingPass());
943 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(MainFPM)));
944
945 // Create a function that performs CFI checks for cross-DSO calls with
946 // targets in the current module.
947 MPM.addPass(CrossDSOCFIPass());
948
949 // Lower type metadata and the type.test intrinsic. This pass supports
950 // clang's control flow integrity mechanisms (-fsanitize=cfi*) and needs
951 // to be run at link time if CFI is enabled. This pass does nothing if
952 // CFI is disabled.
953 // Enable once we add support for the summary in the new PM.
954#if 0
Peter Collingbourne857aba42017-02-09 21:45:01 +0000955 MPM.addPass(LowerTypeTestsPass(Summary ? PassSummaryAction::Export :
956 PassSummaryAction::None,
Davide Italiano089a9122017-01-24 00:57:39 +0000957 Summary));
958#endif
959
960 // Add late LTO optimization passes.
961 // Delete basic blocks, which optimization passes may have killed.
962 MPM.addPass(createModuleToFunctionPassAdaptor(SimplifyCFGPass()));
963
964 // Drop bodies of available eternally objects to improve GlobalDCE.
965 MPM.addPass(EliminateAvailableExternallyPass());
966
967 // Now that we have optimized the program, discard unreachable functions.
968 MPM.addPass(GlobalDCEPass());
969
970 // FIXME: Enable MergeFuncs, conditionally, after ported, maybe.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000971 return MPM;
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000972}
973
Chandler Carruth060ad612016-12-23 20:38:19 +0000974AAManager PassBuilder::buildDefaultAAPipeline() {
975 AAManager AA;
976
977 // The order in which these are registered determines their priority when
978 // being queried.
979
980 // First we register the basic alias analysis that provides the majority of
981 // per-function local AA logic. This is a stateless, on-demand local set of
982 // AA techniques.
983 AA.registerFunctionAnalysis<BasicAA>();
984
985 // Next we query fast, specialized alias analyses that wrap IR-embedded
986 // information about aliasing.
987 AA.registerFunctionAnalysis<ScopedNoAliasAA>();
988 AA.registerFunctionAnalysis<TypeBasedAA>();
989
990 // Add support for querying global aliasing information when available.
Chandler Carruth534d6442016-12-24 05:11:17 +0000991 // Because the `AAManager` is a function analysis and `GlobalsAA` is a module
992 // analysis, all that the `AAManager` can do is query for any *cached*
Chandler Carruthe87fc8c2017-02-12 05:34:04 +0000993 // results from `GlobalsAA` through a readonly proxy.
Chandler Carruth060ad612016-12-23 20:38:19 +0000994 AA.registerModuleAnalysis<GlobalsAA>();
Chandler Carruth060ad612016-12-23 20:38:19 +0000995
996 return AA;
997}
998
Chandler Carruth241bf242016-08-03 07:44:48 +0000999static Optional<int> parseRepeatPassName(StringRef Name) {
1000 if (!Name.consume_front("repeat<") || !Name.consume_back(">"))
1001 return None;
1002 int Count;
1003 if (Name.getAsInteger(0, Count) || Count <= 0)
1004 return None;
1005 return Count;
1006}
1007
Chandler Carruth05ca5ac2016-12-28 11:07:33 +00001008static Optional<int> parseDevirtPassName(StringRef Name) {
1009 if (!Name.consume_front("devirt<") || !Name.consume_back(">"))
1010 return None;
1011 int Count;
1012 if (Name.getAsInteger(0, Count) || Count <= 0)
1013 return None;
1014 return Count;
1015}
1016
Chandler Carruth8b3be4e2017-06-01 11:39:39 +00001017/// Tests whether a pass name starts with a valid prefix for a default pipeline
1018/// alias.
1019static bool startsWithDefaultPipelineAliasPrefix(StringRef Name) {
1020 return Name.startswith("default") || Name.startswith("thinlto") ||
1021 Name.startswith("lto");
1022}
1023
Chandler Carruth66445382014-01-11 08:16:35 +00001024static bool isModulePassName(StringRef Name) {
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001025 // Manually handle aliases for pre-configured pipeline fragments.
Chandler Carruth8b3be4e2017-06-01 11:39:39 +00001026 if (startsWithDefaultPipelineAliasPrefix(Name))
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001027 return DefaultAliasRegex.match(Name);
1028
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001029 // Explicitly handle pass manager names.
1030 if (Name == "module")
1031 return true;
1032 if (Name == "cgscc")
1033 return true;
1034 if (Name == "function")
1035 return true;
1036
Chandler Carruth241bf242016-08-03 07:44:48 +00001037 // Explicitly handle custom-parsed pass names.
1038 if (parseRepeatPassName(Name))
1039 return true;
1040
Chandler Carruth74a8a222016-06-17 07:15:29 +00001041#define MODULE_PASS(NAME, CREATE_PASS) \
1042 if (Name == NAME) \
1043 return true;
Chandler Carruth628503e2015-01-06 02:10:51 +00001044#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001045 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +00001046 return true;
1047#include "PassRegistry.def"
1048
Chandler Carruth66445382014-01-11 08:16:35 +00001049 return false;
1050}
1051
Chandler Carruth572e3402014-04-21 11:12:00 +00001052static bool isCGSCCPassName(StringRef Name) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001053 // Explicitly handle pass manager names.
1054 if (Name == "cgscc")
1055 return true;
1056 if (Name == "function")
1057 return true;
1058
Chandler Carruth241bf242016-08-03 07:44:48 +00001059 // Explicitly handle custom-parsed pass names.
1060 if (parseRepeatPassName(Name))
1061 return true;
Chandler Carruth05ca5ac2016-12-28 11:07:33 +00001062 if (parseDevirtPassName(Name))
1063 return true;
Chandler Carruth241bf242016-08-03 07:44:48 +00001064
Chandler Carruth74a8a222016-06-17 07:15:29 +00001065#define CGSCC_PASS(NAME, CREATE_PASS) \
1066 if (Name == NAME) \
1067 return true;
Chandler Carruth628503e2015-01-06 02:10:51 +00001068#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001069 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +00001070 return true;
1071#include "PassRegistry.def"
1072
Chandler Carruth572e3402014-04-21 11:12:00 +00001073 return false;
1074}
1075
Chandler Carruthd8330982014-01-12 09:34:22 +00001076static bool isFunctionPassName(StringRef Name) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001077 // Explicitly handle pass manager names.
1078 if (Name == "function")
1079 return true;
1080 if (Name == "loop")
1081 return true;
1082
Chandler Carruth241bf242016-08-03 07:44:48 +00001083 // Explicitly handle custom-parsed pass names.
1084 if (parseRepeatPassName(Name))
1085 return true;
1086
Chandler Carruth74a8a222016-06-17 07:15:29 +00001087#define FUNCTION_PASS(NAME, CREATE_PASS) \
1088 if (Name == NAME) \
1089 return true;
Chandler Carruth628503e2015-01-06 02:10:51 +00001090#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001091 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +00001092 return true;
1093#include "PassRegistry.def"
1094
Chandler Carruthd8330982014-01-12 09:34:22 +00001095 return false;
1096}
1097
Justin Bognereecc3c82016-02-25 07:23:08 +00001098static bool isLoopPassName(StringRef Name) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001099 // Explicitly handle pass manager names.
1100 if (Name == "loop")
1101 return true;
1102
Chandler Carruth241bf242016-08-03 07:44:48 +00001103 // Explicitly handle custom-parsed pass names.
1104 if (parseRepeatPassName(Name))
1105 return true;
1106
Chandler Carruth74a8a222016-06-17 07:15:29 +00001107#define LOOP_PASS(NAME, CREATE_PASS) \
1108 if (Name == NAME) \
1109 return true;
Justin Bognereecc3c82016-02-25 07:23:08 +00001110#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
1111 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
1112 return true;
1113#include "PassRegistry.def"
1114
1115 return false;
1116}
1117
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001118Optional<std::vector<PassBuilder::PipelineElement>>
1119PassBuilder::parsePipelineText(StringRef Text) {
1120 std::vector<PipelineElement> ResultPipeline;
1121
1122 SmallVector<std::vector<PipelineElement> *, 4> PipelineStack = {
1123 &ResultPipeline};
1124 for (;;) {
1125 std::vector<PipelineElement> &Pipeline = *PipelineStack.back();
1126 size_t Pos = Text.find_first_of(",()");
1127 Pipeline.push_back({Text.substr(0, Pos), {}});
1128
1129 // If we have a single terminating name, we're done.
1130 if (Pos == Text.npos)
1131 break;
1132
1133 char Sep = Text[Pos];
1134 Text = Text.substr(Pos + 1);
1135 if (Sep == ',')
1136 // Just a name ending in a comma, continue.
1137 continue;
1138
1139 if (Sep == '(') {
1140 // Push the inner pipeline onto the stack to continue processing.
1141 PipelineStack.push_back(&Pipeline.back().InnerPipeline);
1142 continue;
1143 }
1144
1145 assert(Sep == ')' && "Bogus separator!");
1146 // When handling the close parenthesis, we greedily consume them to avoid
1147 // empty strings in the pipeline.
1148 do {
1149 // If we try to pop the outer pipeline we have unbalanced parentheses.
1150 if (PipelineStack.size() == 1)
1151 return None;
1152
1153 PipelineStack.pop_back();
1154 } while (Text.consume_front(")"));
1155
1156 // Check if we've finished parsing.
1157 if (Text.empty())
1158 break;
1159
1160 // Otherwise, the end of an inner pipeline always has to be followed by
1161 // a comma, and then we can continue.
1162 if (!Text.consume_front(","))
1163 return None;
1164 }
1165
1166 if (PipelineStack.size() > 1)
1167 // Unbalanced paretheses.
1168 return None;
1169
1170 assert(PipelineStack.back() == &ResultPipeline &&
1171 "Wrong pipeline at the bottom of the stack!");
1172 return {std::move(ResultPipeline)};
1173}
1174
1175bool PassBuilder::parseModulePass(ModulePassManager &MPM,
1176 const PipelineElement &E, bool VerifyEachPass,
1177 bool DebugLogging) {
1178 auto &Name = E.Name;
1179 auto &InnerPipeline = E.InnerPipeline;
1180
1181 // First handle complex passes like the pass managers which carry pipelines.
1182 if (!InnerPipeline.empty()) {
1183 if (Name == "module") {
1184 ModulePassManager NestedMPM(DebugLogging);
1185 if (!parseModulePassPipeline(NestedMPM, InnerPipeline, VerifyEachPass,
1186 DebugLogging))
1187 return false;
1188 MPM.addPass(std::move(NestedMPM));
1189 return true;
1190 }
1191 if (Name == "cgscc") {
1192 CGSCCPassManager CGPM(DebugLogging);
1193 if (!parseCGSCCPassPipeline(CGPM, InnerPipeline, VerifyEachPass,
1194 DebugLogging))
1195 return false;
1196 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPM),
1197 DebugLogging));
1198 return true;
1199 }
1200 if (Name == "function") {
1201 FunctionPassManager FPM(DebugLogging);
1202 if (!parseFunctionPassPipeline(FPM, InnerPipeline, VerifyEachPass,
1203 DebugLogging))
1204 return false;
1205 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
1206 return true;
1207 }
Chandler Carruth241bf242016-08-03 07:44:48 +00001208 if (auto Count = parseRepeatPassName(Name)) {
1209 ModulePassManager NestedMPM(DebugLogging);
1210 if (!parseModulePassPipeline(NestedMPM, InnerPipeline, VerifyEachPass,
1211 DebugLogging))
1212 return false;
Chandler Carrutha053a882016-08-04 03:52:53 +00001213 MPM.addPass(createRepeatedPass(*Count, std::move(NestedMPM)));
Chandler Carruth241bf242016-08-03 07:44:48 +00001214 return true;
1215 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001216 // Normal passes can't have pipelines.
1217 return false;
1218 }
1219
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001220 // Manually handle aliases for pre-configured pipeline fragments.
Chandler Carruth8b3be4e2017-06-01 11:39:39 +00001221 if (startsWithDefaultPipelineAliasPrefix(Name)) {
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001222 SmallVector<StringRef, 3> Matches;
1223 if (!DefaultAliasRegex.match(Name, &Matches))
1224 return false;
1225 assert(Matches.size() == 3 && "Must capture two matched strings!");
1226
Jordan Rosef85a95f2016-07-25 18:34:51 +00001227 OptimizationLevel L = StringSwitch<OptimizationLevel>(Matches[2])
1228 .Case("O0", O0)
1229 .Case("O1", O1)
1230 .Case("O2", O2)
1231 .Case("O3", O3)
1232 .Case("Os", Os)
1233 .Case("Oz", Oz);
Chandler Carruthe3f50642016-12-22 06:59:15 +00001234 if (L == O0)
1235 // At O0 we do nothing at all!
1236 return true;
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001237
1238 if (Matches[1] == "default") {
Chandler Carruthe3f50642016-12-22 06:59:15 +00001239 MPM.addPass(buildPerModuleDefaultPipeline(L, DebugLogging));
Chandler Carruth8b3be4e2017-06-01 11:39:39 +00001240 } else if (Matches[1] == "thinlto-pre-link") {
1241 MPM.addPass(buildThinLTOPreLinkDefaultPipeline(L, DebugLogging));
1242 } else if (Matches[1] == "thinlto") {
1243 MPM.addPass(buildThinLTODefaultPipeline(L, DebugLogging));
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001244 } else if (Matches[1] == "lto-pre-link") {
Chandler Carruthe3f50642016-12-22 06:59:15 +00001245 MPM.addPass(buildLTOPreLinkDefaultPipeline(L, DebugLogging));
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001246 } else {
1247 assert(Matches[1] == "lto" && "Not one of the matched options!");
Chandler Carruthe3f50642016-12-22 06:59:15 +00001248 MPM.addPass(buildLTODefaultPipeline(L, DebugLogging));
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001249 }
1250 return true;
1251 }
1252
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001253 // Finally expand the basic registered passes from the .inc file.
Chandler Carruth58944182014-04-21 08:08:50 +00001254#define MODULE_PASS(NAME, CREATE_PASS) \
1255 if (Name == NAME) { \
1256 MPM.addPass(CREATE_PASS); \
1257 return true; \
Chandler Carruth52eef882014-01-12 12:15:39 +00001258 }
Chandler Carruth628503e2015-01-06 02:10:51 +00001259#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
1260 if (Name == "require<" NAME ">") { \
Chandler Carruth9b35e6d2016-08-19 18:36:06 +00001261 MPM.addPass( \
1262 RequireAnalysisPass< \
1263 std::remove_reference<decltype(CREATE_PASS)>::type, Module>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +00001264 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001265 } \
1266 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +00001267 MPM.addPass(InvalidateAnalysisPass< \
1268 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001269 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +00001270 }
1271#include "PassRegistry.def"
1272
Chandler Carruth66445382014-01-11 08:16:35 +00001273 return false;
1274}
1275
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001276bool PassBuilder::parseCGSCCPass(CGSCCPassManager &CGPM,
1277 const PipelineElement &E, bool VerifyEachPass,
1278 bool DebugLogging) {
1279 auto &Name = E.Name;
1280 auto &InnerPipeline = E.InnerPipeline;
1281
1282 // First handle complex passes like the pass managers which carry pipelines.
1283 if (!InnerPipeline.empty()) {
1284 if (Name == "cgscc") {
1285 CGSCCPassManager NestedCGPM(DebugLogging);
1286 if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
1287 DebugLogging))
1288 return false;
1289 // Add the nested pass manager with the appropriate adaptor.
1290 CGPM.addPass(std::move(NestedCGPM));
1291 return true;
1292 }
1293 if (Name == "function") {
1294 FunctionPassManager FPM(DebugLogging);
1295 if (!parseFunctionPassPipeline(FPM, InnerPipeline, VerifyEachPass,
1296 DebugLogging))
1297 return false;
1298 // Add the nested pass manager with the appropriate adaptor.
1299 CGPM.addPass(
1300 createCGSCCToFunctionPassAdaptor(std::move(FPM), DebugLogging));
1301 return true;
1302 }
Chandler Carruth241bf242016-08-03 07:44:48 +00001303 if (auto Count = parseRepeatPassName(Name)) {
1304 CGSCCPassManager NestedCGPM(DebugLogging);
1305 if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
1306 DebugLogging))
1307 return false;
Chandler Carrutha053a882016-08-04 03:52:53 +00001308 CGPM.addPass(createRepeatedPass(*Count, std::move(NestedCGPM)));
Chandler Carruth241bf242016-08-03 07:44:48 +00001309 return true;
1310 }
Chandler Carruth05ca5ac2016-12-28 11:07:33 +00001311 if (auto MaxRepetitions = parseDevirtPassName(Name)) {
1312 CGSCCPassManager NestedCGPM(DebugLogging);
1313 if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
1314 DebugLogging))
1315 return false;
1316 CGPM.addPass(createDevirtSCCRepeatedPass(std::move(NestedCGPM),
1317 *MaxRepetitions, DebugLogging));
1318 return true;
1319 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001320 // Normal passes can't have pipelines.
1321 return false;
1322 }
1323
1324 // Now expand the basic registered passes from the .inc file.
Chandler Carruth572e3402014-04-21 11:12:00 +00001325#define CGSCC_PASS(NAME, CREATE_PASS) \
1326 if (Name == NAME) { \
1327 CGPM.addPass(CREATE_PASS); \
1328 return true; \
1329 }
Chandler Carruth628503e2015-01-06 02:10:51 +00001330#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
1331 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +00001332 CGPM.addPass(RequireAnalysisPass< \
Chandler Carruth9b35e6d2016-08-19 18:36:06 +00001333 std::remove_reference<decltype(CREATE_PASS)>::type, \
Chandler Carruth88823462016-08-24 09:37:14 +00001334 LazyCallGraph::SCC, CGSCCAnalysisManager, LazyCallGraph &, \
1335 CGSCCUpdateResult &>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +00001336 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001337 } \
1338 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +00001339 CGPM.addPass(InvalidateAnalysisPass< \
1340 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001341 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +00001342 }
1343#include "PassRegistry.def"
1344
Chandler Carruth572e3402014-04-21 11:12:00 +00001345 return false;
1346}
1347
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001348bool PassBuilder::parseFunctionPass(FunctionPassManager &FPM,
1349 const PipelineElement &E,
1350 bool VerifyEachPass, bool DebugLogging) {
1351 auto &Name = E.Name;
1352 auto &InnerPipeline = E.InnerPipeline;
1353
1354 // First handle complex passes like the pass managers which carry pipelines.
1355 if (!InnerPipeline.empty()) {
1356 if (Name == "function") {
1357 FunctionPassManager NestedFPM(DebugLogging);
1358 if (!parseFunctionPassPipeline(NestedFPM, InnerPipeline, VerifyEachPass,
1359 DebugLogging))
1360 return false;
1361 // Add the nested pass manager with the appropriate adaptor.
1362 FPM.addPass(std::move(NestedFPM));
1363 return true;
1364 }
1365 if (Name == "loop") {
1366 LoopPassManager LPM(DebugLogging);
1367 if (!parseLoopPassPipeline(LPM, InnerPipeline, VerifyEachPass,
1368 DebugLogging))
1369 return false;
1370 // Add the nested pass manager with the appropriate adaptor.
1371 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM)));
1372 return true;
1373 }
Chandler Carruth241bf242016-08-03 07:44:48 +00001374 if (auto Count = parseRepeatPassName(Name)) {
1375 FunctionPassManager NestedFPM(DebugLogging);
1376 if (!parseFunctionPassPipeline(NestedFPM, InnerPipeline, VerifyEachPass,
1377 DebugLogging))
1378 return false;
Chandler Carrutha053a882016-08-04 03:52:53 +00001379 FPM.addPass(createRepeatedPass(*Count, std::move(NestedFPM)));
Chandler Carruth241bf242016-08-03 07:44:48 +00001380 return true;
1381 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001382 // Normal passes can't have pipelines.
1383 return false;
1384 }
1385
1386 // Now expand the basic registered passes from the .inc file.
Chandler Carruth58944182014-04-21 08:08:50 +00001387#define FUNCTION_PASS(NAME, CREATE_PASS) \
1388 if (Name == NAME) { \
1389 FPM.addPass(CREATE_PASS); \
1390 return true; \
Chandler Carruth52eef882014-01-12 12:15:39 +00001391 }
Chandler Carruth628503e2015-01-06 02:10:51 +00001392#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
1393 if (Name == "require<" NAME ">") { \
Chandler Carruth9b35e6d2016-08-19 18:36:06 +00001394 FPM.addPass( \
1395 RequireAnalysisPass< \
1396 std::remove_reference<decltype(CREATE_PASS)>::type, Function>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +00001397 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001398 } \
1399 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +00001400 FPM.addPass(InvalidateAnalysisPass< \
1401 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001402 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +00001403 }
1404#include "PassRegistry.def"
1405
Chandler Carruthd8330982014-01-12 09:34:22 +00001406 return false;
1407}
1408
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001409bool PassBuilder::parseLoopPass(LoopPassManager &LPM, const PipelineElement &E,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001410 bool VerifyEachPass, bool DebugLogging) {
Chandler Carruth241bf242016-08-03 07:44:48 +00001411 StringRef Name = E.Name;
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001412 auto &InnerPipeline = E.InnerPipeline;
1413
1414 // First handle complex passes like the pass managers which carry pipelines.
1415 if (!InnerPipeline.empty()) {
1416 if (Name == "loop") {
1417 LoopPassManager NestedLPM(DebugLogging);
1418 if (!parseLoopPassPipeline(NestedLPM, InnerPipeline, VerifyEachPass,
1419 DebugLogging))
1420 return false;
1421 // Add the nested pass manager with the appropriate adaptor.
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001422 LPM.addPass(std::move(NestedLPM));
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001423 return true;
1424 }
Chandler Carruth241bf242016-08-03 07:44:48 +00001425 if (auto Count = parseRepeatPassName(Name)) {
1426 LoopPassManager NestedLPM(DebugLogging);
1427 if (!parseLoopPassPipeline(NestedLPM, InnerPipeline, VerifyEachPass,
1428 DebugLogging))
1429 return false;
Chandler Carrutha053a882016-08-04 03:52:53 +00001430 LPM.addPass(createRepeatedPass(*Count, std::move(NestedLPM)));
Chandler Carruth241bf242016-08-03 07:44:48 +00001431 return true;
1432 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001433 // Normal passes can't have pipelines.
1434 return false;
1435 }
1436
1437 // Now expand the basic registered passes from the .inc file.
Justin Bognereecc3c82016-02-25 07:23:08 +00001438#define LOOP_PASS(NAME, CREATE_PASS) \
1439 if (Name == NAME) { \
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001440 LPM.addPass(CREATE_PASS); \
Justin Bognereecc3c82016-02-25 07:23:08 +00001441 return true; \
1442 }
1443#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
1444 if (Name == "require<" NAME ">") { \
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001445 LPM.addPass(RequireAnalysisPass< \
Chandler Carruth410eaeb2017-01-11 06:23:21 +00001446 std::remove_reference<decltype(CREATE_PASS)>::type, Loop, \
1447 LoopAnalysisManager, LoopStandardAnalysisResults &, \
1448 LPMUpdater &>()); \
Justin Bognereecc3c82016-02-25 07:23:08 +00001449 return true; \
1450 } \
1451 if (Name == "invalidate<" NAME ">") { \
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001452 LPM.addPass(InvalidateAnalysisPass< \
Chandler Carruth470734b2016-02-26 12:30:18 +00001453 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Justin Bognereecc3c82016-02-25 07:23:08 +00001454 return true; \
1455 }
1456#include "PassRegistry.def"
1457
1458 return false;
1459}
1460
Chandler Carruthedf59962016-02-18 09:45:17 +00001461bool PassBuilder::parseAAPassName(AAManager &AA, StringRef Name) {
Chandler Carruth45a9c202016-03-11 09:15:11 +00001462#define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
1463 if (Name == NAME) { \
1464 AA.registerModuleAnalysis< \
1465 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
1466 return true; \
1467 }
Chandler Carruthedf59962016-02-18 09:45:17 +00001468#define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
1469 if (Name == NAME) { \
Chandler Carruth58dde8c2016-02-26 12:17:54 +00001470 AA.registerFunctionAnalysis< \
1471 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
Chandler Carruthedf59962016-02-18 09:45:17 +00001472 return true; \
1473 }
1474#include "PassRegistry.def"
1475
1476 return false;
1477}
1478
Justin Bognereecc3c82016-02-25 07:23:08 +00001479bool PassBuilder::parseLoopPassPipeline(LoopPassManager &LPM,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001480 ArrayRef<PipelineElement> Pipeline,
Justin Bognereecc3c82016-02-25 07:23:08 +00001481 bool VerifyEachPass,
1482 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001483 for (const auto &Element : Pipeline) {
1484 if (!parseLoopPass(LPM, Element, VerifyEachPass, DebugLogging))
1485 return false;
1486 // FIXME: No verifier support for Loop passes!
Justin Bognereecc3c82016-02-25 07:23:08 +00001487 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001488 return true;
Justin Bognereecc3c82016-02-25 07:23:08 +00001489}
1490
Chandler Carruth1ff77242015-03-07 09:02:36 +00001491bool PassBuilder::parseFunctionPassPipeline(FunctionPassManager &FPM,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001492 ArrayRef<PipelineElement> Pipeline,
Chandler Carruth1ff77242015-03-07 09:02:36 +00001493 bool VerifyEachPass,
1494 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001495 for (const auto &Element : Pipeline) {
1496 if (!parseFunctionPass(FPM, Element, VerifyEachPass, DebugLogging))
1497 return false;
1498 if (VerifyEachPass)
1499 FPM.addPass(VerifierPass());
Chandler Carruthd8330982014-01-12 09:34:22 +00001500 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001501 return true;
Chandler Carruthd8330982014-01-12 09:34:22 +00001502}
1503
Chandler Carruth1ff77242015-03-07 09:02:36 +00001504bool PassBuilder::parseCGSCCPassPipeline(CGSCCPassManager &CGPM,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001505 ArrayRef<PipelineElement> Pipeline,
Chandler Carruth1ff77242015-03-07 09:02:36 +00001506 bool VerifyEachPass,
1507 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001508 for (const auto &Element : Pipeline) {
1509 if (!parseCGSCCPass(CGPM, Element, VerifyEachPass, DebugLogging))
1510 return false;
1511 // FIXME: No verifier support for CGSCC passes!
Chandler Carruth572e3402014-04-21 11:12:00 +00001512 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001513 return true;
Chandler Carruth572e3402014-04-21 11:12:00 +00001514}
1515
NAKAMURA Takumia42f5282016-05-16 10:13:37 +00001516void PassBuilder::crossRegisterProxies(LoopAnalysisManager &LAM,
1517 FunctionAnalysisManager &FAM,
1518 CGSCCAnalysisManager &CGAM,
1519 ModuleAnalysisManager &MAM) {
1520 MAM.registerPass([&] { return FunctionAnalysisManagerModuleProxy(FAM); });
1521 MAM.registerPass([&] { return CGSCCAnalysisManagerModuleProxy(CGAM); });
NAKAMURA Takumia42f5282016-05-16 10:13:37 +00001522 CGAM.registerPass([&] { return ModuleAnalysisManagerCGSCCProxy(MAM); });
1523 FAM.registerPass([&] { return CGSCCAnalysisManagerFunctionProxy(CGAM); });
1524 FAM.registerPass([&] { return ModuleAnalysisManagerFunctionProxy(MAM); });
1525 FAM.registerPass([&] { return LoopAnalysisManagerFunctionProxy(LAM); });
1526 LAM.registerPass([&] { return FunctionAnalysisManagerLoopProxy(FAM); });
1527}
1528
Chandler Carruth1ff77242015-03-07 09:02:36 +00001529bool PassBuilder::parseModulePassPipeline(ModulePassManager &MPM,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001530 ArrayRef<PipelineElement> Pipeline,
Chandler Carruth1ff77242015-03-07 09:02:36 +00001531 bool VerifyEachPass,
1532 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001533 for (const auto &Element : Pipeline) {
1534 if (!parseModulePass(MPM, Element, VerifyEachPass, DebugLogging))
1535 return false;
1536 if (VerifyEachPass)
1537 MPM.addPass(VerifierPass());
Chandler Carruth66445382014-01-11 08:16:35 +00001538 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001539 return true;
Chandler Carruth66445382014-01-11 08:16:35 +00001540}
1541
1542// Primary pass pipeline description parsing routine.
1543// FIXME: Should this routine accept a TargetMachine or require the caller to
1544// pre-populate the analysis managers with target-specific stuff?
Chandler Carruth1ff77242015-03-07 09:02:36 +00001545bool PassBuilder::parsePassPipeline(ModulePassManager &MPM,
1546 StringRef PipelineText, bool VerifyEachPass,
1547 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001548 auto Pipeline = parsePipelineText(PipelineText);
1549 if (!Pipeline || Pipeline->empty())
1550 return false;
Chandler Carruth66445382014-01-11 08:16:35 +00001551
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001552 // If the first name isn't at the module layer, wrap the pipeline up
1553 // automatically.
1554 StringRef FirstName = Pipeline->front().Name;
Chandler Carruth66445382014-01-11 08:16:35 +00001555
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001556 if (!isModulePassName(FirstName)) {
1557 if (isCGSCCPassName(FirstName))
1558 Pipeline = {{"cgscc", std::move(*Pipeline)}};
1559 else if (isFunctionPassName(FirstName))
1560 Pipeline = {{"function", std::move(*Pipeline)}};
1561 else if (isLoopPassName(FirstName))
1562 Pipeline = {{"function", {{"loop", std::move(*Pipeline)}}}};
1563 else
1564 // Unknown pass name!
Chandler Carruth572e3402014-04-21 11:12:00 +00001565 return false;
Chandler Carruth572e3402014-04-21 11:12:00 +00001566 }
1567
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001568 return parseModulePassPipeline(MPM, *Pipeline, VerifyEachPass, DebugLogging);
Chandler Carruth66445382014-01-11 08:16:35 +00001569}
Chandler Carruthedf59962016-02-18 09:45:17 +00001570
1571bool PassBuilder::parseAAPipeline(AAManager &AA, StringRef PipelineText) {
Chandler Carruth060ad612016-12-23 20:38:19 +00001572 // If the pipeline just consists of the word 'default' just replace the AA
1573 // manager with our default one.
1574 if (PipelineText == "default") {
1575 AA = buildDefaultAAPipeline();
1576 return true;
1577 }
1578
Chandler Carruthedf59962016-02-18 09:45:17 +00001579 while (!PipelineText.empty()) {
1580 StringRef Name;
1581 std::tie(Name, PipelineText) = PipelineText.split(',');
1582 if (!parseAAPassName(AA, Name))
1583 return false;
1584 }
1585
1586 return true;
1587}