blob: f72b38e61e7b778973c5630782210ff2f19ffa68 [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 Nemet0965da22017-10-09 23:19:02 +000044#include "llvm/Analysis/OptimizationRemarkEmitter.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"
Matthew Simpsoncb585582017-10-25 13:40:08 +000066#include "llvm/Transforms/IPO/CalledValuePropagation.h"
Davide Italiano164b9bc2016-05-05 00:51:09 +000067#include "llvm/Transforms/IPO/ConstantMerge.h"
Davide Italiano92b933a2016-07-09 03:25:35 +000068#include "llvm/Transforms/IPO/CrossDSOCFI.h"
Sean Silvae3bb4572016-06-12 09:16:39 +000069#include "llvm/Transforms/IPO/DeadArgumentElimination.h"
Davide Italiano344e8382016-05-05 02:37:32 +000070#include "llvm/Transforms/IPO/ElimAvailExtern.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000071#include "llvm/Transforms/IPO/ForceFunctionAttrs.h"
Chandler Carruth9c4ed172016-02-18 11:03:11 +000072#include "llvm/Transforms/IPO/FunctionAttrs.h"
Teresa Johnson21241572016-07-18 21:22:24 +000073#include "llvm/Transforms/IPO/FunctionImport.h"
Davide Italiano66228c42016-05-03 19:39:15 +000074#include "llvm/Transforms/IPO/GlobalDCE.h"
Justin Bogner1a075012016-04-26 00:28:01 +000075#include "llvm/Transforms/IPO/GlobalOpt.h"
Davide Italiano2ae76dd2016-11-21 00:28:23 +000076#include "llvm/Transforms/IPO/GlobalSplit.h"
Chandler Carruth3a040e62015-12-27 08:41:34 +000077#include "llvm/Transforms/IPO/InferFunctionAttrs.h"
Chandler Carruth1d963112016-12-20 03:15:32 +000078#include "llvm/Transforms/IPO/Inliner.h"
Justin Bogner4563a062016-04-26 20:15:52 +000079#include "llvm/Transforms/IPO/Internalize.h"
Davide Italianoe8ae0b52016-07-11 18:10:06 +000080#include "llvm/Transforms/IPO/LowerTypeTests.h"
Easwaran Raman1832bf62016-06-27 16:50:18 +000081#include "llvm/Transforms/IPO/PartialInlining.h"
Davide Italianof54f2f02016-05-05 21:05:36 +000082#include "llvm/Transforms/IPO/SCCP.h"
Justin Bogner21e15372015-10-30 23:28:12 +000083#include "llvm/Transforms/IPO/StripDeadPrototypes.h"
Davide Italianod737dd22016-06-14 21:44:19 +000084#include "llvm/Transforms/IPO/WholeProgramDevirt.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +000085#include "llvm/Transforms/InstCombine/InstCombine.h"
Xinliang David Lie6b89292016-04-18 17:47:38 +000086#include "llvm/Transforms/InstrProfiling.h"
Chandler Carruth00a301d2017-11-14 01:30:04 +000087#include "llvm/Transforms/Instrumentation/BoundsChecking.h"
Xinliang David Li8aebf442016-05-06 05:49:19 +000088#include "llvm/Transforms/PGOInstrumentation.h"
Xinliang David Lid38392e2016-05-27 23:20:16 +000089#include "llvm/Transforms/SampleProfile.h"
Justin Bogner19b67992015-10-30 23:13:18 +000090#include "llvm/Transforms/Scalar/ADCE.h"
Sean Silvaa4c2d152016-06-15 06:18:01 +000091#include "llvm/Transforms/Scalar/AlignmentFromAssumptions.h"
Davide Italiano655a1452016-05-25 01:57:04 +000092#include "llvm/Transforms/Scalar/BDCE.h"
Jun Bum Lim0c990072017-11-03 20:41:16 +000093#include "llvm/Transforms/Scalar/CallSiteSplitting.h"
Adam Nemet3beef412016-07-18 16:29:17 +000094#include "llvm/Transforms/Scalar/ConstantHoisting.h"
Sean Silvab025d372016-07-06 23:26:29 +000095#include "llvm/Transforms/Scalar/CorrelatedValuePropagation.h"
Justin Bogner395c2122016-04-22 19:40:41 +000096#include "llvm/Transforms/Scalar/DCE.h"
Justin Bogner594e07b2016-05-17 21:38:13 +000097#include "llvm/Transforms/Scalar/DeadStoreElimination.h"
Sanjay Patel6fd43912017-09-09 13:38:18 +000098#include "llvm/Transforms/Scalar/DivRemPairs.h"
Chandler Carruthe8c686a2015-02-01 10:51:23 +000099#include "llvm/Transforms/Scalar/EarlyCSE.h"
Michael Kuperstein83b753d2016-06-24 23:32:02 +0000100#include "llvm/Transforms/Scalar/Float2Int.h"
Easwaran Raman019e0bf2016-06-03 22:54:26 +0000101#include "llvm/Transforms/Scalar/GVN.h"
Davide Italiano89ab89d2016-06-14 00:49:23 +0000102#include "llvm/Transforms/Scalar/GuardWidening.h"
Chandler Carruth3bab7e12017-01-11 09:43:56 +0000103#include "llvm/Transforms/Scalar/IVUsersPrinter.h"
Sanjoy Das4d4339d2016-06-05 18:01:19 +0000104#include "llvm/Transforms/Scalar/IndVarSimplify.h"
Sean Silva46590d52016-06-14 00:51:09 +0000105#include "llvm/Transforms/Scalar/JumpThreading.h"
Dehao Chenf400a092016-07-12 22:42:24 +0000106#include "llvm/Transforms/Scalar/LICM.h"
Chandler Carruth3bab7e12017-01-11 09:43:56 +0000107#include "llvm/Transforms/Scalar/LoopAccessAnalysisPrinter.h"
Teresa Johnson1eca6bc2016-08-13 04:11:27 +0000108#include "llvm/Transforms/Scalar/LoopDataPrefetch.h"
Jun Bum Limc837af32016-07-14 18:28:29 +0000109#include "llvm/Transforms/Scalar/LoopDeletion.h"
Adam Nemetb2593f72016-07-18 16:29:27 +0000110#include "llvm/Transforms/Scalar/LoopDistribute.h"
Dehao Chenb9f8e292016-07-12 18:45:51 +0000111#include "llvm/Transforms/Scalar/LoopIdiomRecognize.h"
Dehao Chendcafd5e2016-07-15 16:42:11 +0000112#include "llvm/Transforms/Scalar/LoopInstSimplify.h"
Chandler Carruthbaabda92017-01-27 01:32:26 +0000113#include "llvm/Transforms/Scalar/LoopLoadElimination.h"
Chandler Carruth3bab7e12017-01-11 09:43:56 +0000114#include "llvm/Transforms/Scalar/LoopPassManager.h"
Artur Pilipenko8fb3d572017-01-25 16:00:44 +0000115#include "llvm/Transforms/Scalar/LoopPredication.h"
Justin Bognerd0d23412016-05-03 22:02:31 +0000116#include "llvm/Transforms/Scalar/LoopRotation.h"
Justin Bognerab6a5132016-05-03 21:47:32 +0000117#include "llvm/Transforms/Scalar/LoopSimplifyCFG.h"
Chandler Carruthe9b18e32017-01-20 08:42:19 +0000118#include "llvm/Transforms/Scalar/LoopSink.h"
Dehao Chen6132ee82016-07-18 21:41:50 +0000119#include "llvm/Transforms/Scalar/LoopStrengthReduce.h"
Sean Silvae3c18a52016-07-19 23:54:23 +0000120#include "llvm/Transforms/Scalar/LoopUnrollPass.h"
Davide Italiano99223442016-05-13 22:52:35 +0000121#include "llvm/Transforms/Scalar/LowerAtomic.h"
Chandler Carruth43e590e2015-01-24 11:13:02 +0000122#include "llvm/Transforms/Scalar/LowerExpectIntrinsic.h"
Michael Kupersteine45d4d92016-07-28 22:08:41 +0000123#include "llvm/Transforms/Scalar/LowerGuardIntrinsic.h"
Sean Silva6347df02016-06-14 02:44:55 +0000124#include "llvm/Transforms/Scalar/MemCpyOptimizer.h"
Davide Italianob49aa5c2016-06-17 19:10:09 +0000125#include "llvm/Transforms/Scalar/MergedLoadStoreMotion.h"
Wei Mi1cf58f82016-07-21 22:28:52 +0000126#include "llvm/Transforms/Scalar/NaryReassociate.h"
Davide Italianoe05e3302016-12-22 16:35:02 +0000127#include "llvm/Transforms/Scalar/NewGVN.h"
Davide Italiano1021c682016-05-25 23:38:53 +0000128#include "llvm/Transforms/Scalar/PartiallyInlineLibCalls.h"
Justin Bognerc2bf63d2016-04-26 23:39:29 +0000129#include "llvm/Transforms/Scalar/Reassociate.h"
Davide Italiano98f7e0e2016-05-18 15:18:25 +0000130#include "llvm/Transforms/Scalar/SCCP.h"
Chandler Carruth29a18a42015-09-12 09:09:14 +0000131#include "llvm/Transforms/Scalar/SROA.h"
Chandler Carruth1353f9a2017-04-27 18:45:20 +0000132#include "llvm/Transforms/Scalar/SimpleLoopUnswitch.h"
Chandler Carruthf49f1a872015-12-27 08:13:45 +0000133#include "llvm/Transforms/Scalar/SimplifyCFG.h"
Justin Bognerb9394902016-04-22 19:54:10 +0000134#include "llvm/Transforms/Scalar/Sink.h"
Michael Kupersteinc4061862016-08-01 21:48:33 +0000135#include "llvm/Transforms/Scalar/SpeculativeExecution.h"
Sean Silva59fe82f2016-07-06 23:48:41 +0000136#include "llvm/Transforms/Scalar/TailRecursionElimination.h"
Xinliang David Li1eaecef2016-06-15 21:51:30 +0000137#include "llvm/Transforms/Utils/AddDiscriminators.h"
Wei Mie04d0ef2016-07-22 18:04:25 +0000138#include "llvm/Transforms/Utils/BreakCriticalEdges.h"
Easwaran Ramane12c4872016-06-09 19:44:46 +0000139#include "llvm/Transforms/Utils/LCSSA.h"
Rong Xu1c0e9b92016-10-18 21:36:27 +0000140#include "llvm/Transforms/Utils/LibCallsShrinkWrap.h"
Davide Italianocd96cfd2016-07-09 03:03:01 +0000141#include "llvm/Transforms/Utils/LoopSimplify.h"
Michael Kuperstein31b83992016-08-12 17:28:27 +0000142#include "llvm/Transforms/Utils/LowerInvoke.h"
Davide Italianocccf4f02016-06-14 03:22:22 +0000143#include "llvm/Transforms/Utils/Mem2Reg.h"
Mehdi Amini27d23792016-09-16 16:56:30 +0000144#include "llvm/Transforms/Utils/NameAnonGlobals.h"
Daniel Berlin439042b2017-02-07 21:10:46 +0000145#include "llvm/Transforms/Utils/PredicateInfo.h"
Davide Italiano16284df2016-07-07 21:14:36 +0000146#include "llvm/Transforms/Utils/SimplifyInstructions.h"
Michael Kuperstein39feb622016-07-25 20:52:00 +0000147#include "llvm/Transforms/Utils/SymbolRewriter.h"
Sean Silvadb90d4d2016-07-09 22:56:50 +0000148#include "llvm/Transforms/Vectorize/LoopVectorize.h"
Sean Silva0dacbd82016-07-09 03:11:29 +0000149#include "llvm/Transforms/Vectorize/SLPVectorizer.h"
Davide Italianocccf4f02016-06-14 03:22:22 +0000150
Chandler Carruth58dde8c2016-02-26 12:17:54 +0000151#include <type_traits>
Chandler Carruth66445382014-01-11 08:16:35 +0000152
153using namespace llvm;
154
Chandler Carruth719ffe12017-02-12 05:38:04 +0000155static cl::opt<unsigned> MaxDevirtIterations("pm-max-devirt-iterations",
156 cl::ReallyHidden, cl::init(4));
Xinliang David Li126157c2017-05-22 16:41:57 +0000157static cl::opt<bool>
158 RunPartialInlining("enable-npm-partial-inlining", cl::init(false),
159 cl::Hidden, cl::ZeroOrMore,
160 cl::desc("Run Partial inlinining pass"));
Chandler Carruth719ffe12017-02-12 05:38:04 +0000161
Davide Italiano8a09b8e2017-05-22 23:41:40 +0000162static cl::opt<bool>
Davide Italiano8e7d11a2017-05-22 23:47:11 +0000163 RunNewGVN("enable-npm-newgvn", cl::init(false),
Davide Italiano8a09b8e2017-05-22 23:41:40 +0000164 cl::Hidden, cl::ZeroOrMore,
165 cl::desc("Run NewGVN instead of GVN"));
166
Geoff Berry3cca1da2017-06-10 15:20:03 +0000167static cl::opt<bool> EnableEarlyCSEMemSSA(
Geoff Berry2573a192017-06-27 22:25:02 +0000168 "enable-npm-earlycse-memssa", cl::init(true), cl::Hidden,
169 cl::desc("Enable the EarlyCSE w/ MemorySSA pass for the new PM (default = on)"));
Geoff Berry3cca1da2017-06-10 15:20:03 +0000170
Chandler Carruthc246a4c2017-04-27 00:28:03 +0000171static cl::opt<bool> EnableGVNHoist(
172 "enable-npm-gvn-hoist", cl::init(false), cl::Hidden,
173 cl::desc("Enable the GVN hoisting pass for the new PM (default = off)"));
174
Davide Italianobe1b6a92017-06-03 23:18:29 +0000175static cl::opt<bool> EnableGVNSink(
176 "enable-npm-gvn-sink", cl::init(false), cl::Hidden,
177 cl::desc("Enable the GVN hoisting pass for the new PM (default = off)"));
178
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000179static Regex DefaultAliasRegex(
180 "^(default|thinlto-pre-link|thinlto|lto-pre-link|lto)<(O[0123sz])>$");
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000181
Chandler Carruthe3f50642016-12-22 06:59:15 +0000182static bool isOptimizingForSize(PassBuilder::OptimizationLevel Level) {
183 switch (Level) {
184 case PassBuilder::O0:
185 case PassBuilder::O1:
186 case PassBuilder::O2:
187 case PassBuilder::O3:
188 return false;
189
190 case PassBuilder::Os:
191 case PassBuilder::Oz:
192 return true;
193 }
194 llvm_unreachable("Invalid optimization level!");
195}
196
Chandler Carruth66445382014-01-11 08:16:35 +0000197namespace {
198
Chandler Carruthd8330982014-01-12 09:34:22 +0000199/// \brief No-op module pass which does nothing.
Chandler Carruth66445382014-01-11 08:16:35 +0000200struct NoOpModulePass {
Sean Silvafd03ac62016-08-09 00:28:38 +0000201 PreservedAnalyses run(Module &M, ModuleAnalysisManager &) {
Chandler Carruth164a2aa62016-06-17 00:11:01 +0000202 return PreservedAnalyses::all();
203 }
Chandler Carrutha13f27c2014-01-11 11:52:05 +0000204 static StringRef name() { return "NoOpModulePass"; }
Chandler Carruth66445382014-01-11 08:16:35 +0000205};
206
Chandler Carruth0b576b32015-01-06 02:50:06 +0000207/// \brief No-op module analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000208class NoOpModuleAnalysis : public AnalysisInfoMixin<NoOpModuleAnalysis> {
209 friend AnalysisInfoMixin<NoOpModuleAnalysis>;
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000210 static AnalysisKey Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000211
212public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000213 struct Result {};
Sean Silvafd03ac62016-08-09 00:28:38 +0000214 Result run(Module &, ModuleAnalysisManager &) { return Result(); }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000215 static StringRef name() { return "NoOpModuleAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000216};
217
Chandler Carruth572e3402014-04-21 11:12:00 +0000218/// \brief No-op CGSCC pass which does nothing.
219struct NoOpCGSCCPass {
Chandler Carruth88823462016-08-24 09:37:14 +0000220 PreservedAnalyses run(LazyCallGraph::SCC &C, CGSCCAnalysisManager &,
221 LazyCallGraph &, CGSCCUpdateResult &UR) {
Chandler Carruth572e3402014-04-21 11:12:00 +0000222 return PreservedAnalyses::all();
223 }
224 static StringRef name() { return "NoOpCGSCCPass"; }
225};
226
Chandler Carruth0b576b32015-01-06 02:50:06 +0000227/// \brief No-op CGSCC analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000228class NoOpCGSCCAnalysis : public AnalysisInfoMixin<NoOpCGSCCAnalysis> {
229 friend AnalysisInfoMixin<NoOpCGSCCAnalysis>;
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000230 static AnalysisKey Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000231
232public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000233 struct Result {};
Chandler Carruth88823462016-08-24 09:37:14 +0000234 Result run(LazyCallGraph::SCC &, CGSCCAnalysisManager &, LazyCallGraph &G) {
Chandler Carruth164a2aa62016-06-17 00:11:01 +0000235 return Result();
236 }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000237 static StringRef name() { return "NoOpCGSCCAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000238};
239
Chandler Carruthd8330982014-01-12 09:34:22 +0000240/// \brief No-op function pass which does nothing.
241struct NoOpFunctionPass {
Sean Silva36e0d012016-08-09 00:28:15 +0000242 PreservedAnalyses run(Function &F, FunctionAnalysisManager &) {
Chandler Carruth164a2aa62016-06-17 00:11:01 +0000243 return PreservedAnalyses::all();
244 }
Chandler Carruthd8330982014-01-12 09:34:22 +0000245 static StringRef name() { return "NoOpFunctionPass"; }
246};
247
Chandler Carruth0b576b32015-01-06 02:50:06 +0000248/// \brief No-op function analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000249class NoOpFunctionAnalysis : public AnalysisInfoMixin<NoOpFunctionAnalysis> {
250 friend AnalysisInfoMixin<NoOpFunctionAnalysis>;
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000251 static AnalysisKey Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000252
253public:
Chandler Carruth0b576b32015-01-06 02:50:06 +0000254 struct Result {};
Sean Silva36e0d012016-08-09 00:28:15 +0000255 Result run(Function &, FunctionAnalysisManager &) { return Result(); }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000256 static StringRef name() { return "NoOpFunctionAnalysis"; }
Chandler Carruth0b576b32015-01-06 02:50:06 +0000257};
258
Justin Bognereecc3c82016-02-25 07:23:08 +0000259/// \brief No-op loop pass which does nothing.
260struct NoOpLoopPass {
Chandler Carruth410eaeb2017-01-11 06:23:21 +0000261 PreservedAnalyses run(Loop &L, LoopAnalysisManager &,
262 LoopStandardAnalysisResults &, LPMUpdater &) {
Chandler Carruth164a2aa62016-06-17 00:11:01 +0000263 return PreservedAnalyses::all();
264 }
Justin Bognereecc3c82016-02-25 07:23:08 +0000265 static StringRef name() { return "NoOpLoopPass"; }
266};
267
268/// \brief No-op loop analysis.
Chandler Carruth30a07302016-03-11 10:33:22 +0000269class NoOpLoopAnalysis : public AnalysisInfoMixin<NoOpLoopAnalysis> {
270 friend AnalysisInfoMixin<NoOpLoopAnalysis>;
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000271 static AnalysisKey Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000272
273public:
Justin Bognereecc3c82016-02-25 07:23:08 +0000274 struct Result {};
Chandler Carruth410eaeb2017-01-11 06:23:21 +0000275 Result run(Loop &, LoopAnalysisManager &, LoopStandardAnalysisResults &) {
276 return Result();
277 }
Justin Bognereecc3c82016-02-25 07:23:08 +0000278 static StringRef name() { return "NoOpLoopAnalysis"; }
Justin Bognereecc3c82016-02-25 07:23:08 +0000279};
280
Chandler Carruthdab4eae2016-11-23 17:53:26 +0000281AnalysisKey NoOpModuleAnalysis::Key;
282AnalysisKey NoOpCGSCCAnalysis::Key;
283AnalysisKey NoOpFunctionAnalysis::Key;
284AnalysisKey NoOpLoopAnalysis::Key;
Chandler Carruthb4faf132016-03-11 10:22:49 +0000285
Chandler Carruth66445382014-01-11 08:16:35 +0000286} // End anonymous namespace.
287
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000288void PassBuilder::invokePeepholeEPCallbacks(
289 FunctionPassManager &FPM, PassBuilder::OptimizationLevel Level) {
290 for (auto &C : PeepholeEPCallbacks)
291 C(FPM, Level);
292}
293
Chandler Carruth1ff77242015-03-07 09:02:36 +0000294void PassBuilder::registerModuleAnalyses(ModuleAnalysisManager &MAM) {
Chandler Carruth74a8a222016-06-17 07:15:29 +0000295#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000296 MAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000297#include "PassRegistry.def"
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000298
299 for (auto &C : ModuleAnalysisRegistrationCallbacks)
300 C(MAM);
Chandler Carruthb70f6732015-01-06 02:21:37 +0000301}
302
Chandler Carruth1ff77242015-03-07 09:02:36 +0000303void PassBuilder::registerCGSCCAnalyses(CGSCCAnalysisManager &CGAM) {
Chandler Carruth74a8a222016-06-17 07:15:29 +0000304#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000305 CGAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000306#include "PassRegistry.def"
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000307
308 for (auto &C : CGSCCAnalysisRegistrationCallbacks)
309 C(CGAM);
Chandler Carruthb70f6732015-01-06 02:21:37 +0000310}
311
Chandler Carruth1ff77242015-03-07 09:02:36 +0000312void PassBuilder::registerFunctionAnalyses(FunctionAnalysisManager &FAM) {
Chandler Carruth74a8a222016-06-17 07:15:29 +0000313#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruthedf59962016-02-18 09:45:17 +0000314 FAM.registerPass([&] { return CREATE_PASS; });
Chandler Carruthb70f6732015-01-06 02:21:37 +0000315#include "PassRegistry.def"
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000316
317 for (auto &C : FunctionAnalysisRegistrationCallbacks)
318 C(FAM);
Chandler Carruthb70f6732015-01-06 02:21:37 +0000319}
320
Justin Bognereecc3c82016-02-25 07:23:08 +0000321void PassBuilder::registerLoopAnalyses(LoopAnalysisManager &LAM) {
Chandler Carruth74a8a222016-06-17 07:15:29 +0000322#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
Justin Bognereecc3c82016-02-25 07:23:08 +0000323 LAM.registerPass([&] { return CREATE_PASS; });
324#include "PassRegistry.def"
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000325
326 for (auto &C : LoopAnalysisRegistrationCallbacks)
327 C(LAM);
Justin Bognereecc3c82016-02-25 07:23:08 +0000328}
329
Chandler Carruthe3f50642016-12-22 06:59:15 +0000330FunctionPassManager
331PassBuilder::buildFunctionSimplificationPipeline(OptimizationLevel Level,
Dehao Chen95f00302017-07-30 04:55:39 +0000332 ThinLTOPhase Phase,
333 bool DebugLogging) {
Chandler Carruthe3f50642016-12-22 06:59:15 +0000334 assert(Level != O0 && "Must request optimizations!");
335 FunctionPassManager FPM(DebugLogging);
336
337 // Form SSA out of local memory accesses after breaking apart aggregates into
338 // scalars.
339 FPM.addPass(SROA());
340
341 // Catch trivial redundancies
Geoff Berry3cca1da2017-06-10 15:20:03 +0000342 FPM.addPass(EarlyCSEPass(EnableEarlyCSEMemSSA));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000343
Davide Italianoc3688312017-06-01 23:08:14 +0000344 // Hoisting of scalars and load expressions.
345 if (EnableGVNHoist)
346 FPM.addPass(GVNHoistPass());
347
Davide Italianobe1b6a92017-06-03 23:18:29 +0000348 // Global value numbering based sinking.
349 if (EnableGVNSink) {
350 FPM.addPass(GVNSinkPass());
351 FPM.addPass(SimplifyCFGPass());
352 }
353
Chandler Carruthe3f50642016-12-22 06:59:15 +0000354 // Speculative execution if the target has divergent branches; otherwise nop.
355 FPM.addPass(SpeculativeExecutionPass());
356
357 // Optimize based on known information about branches, and cleanup afterward.
358 FPM.addPass(JumpThreadingPass());
359 FPM.addPass(CorrelatedValuePropagationPass());
360 FPM.addPass(SimplifyCFGPass());
361 FPM.addPass(InstCombinePass());
362
363 if (!isOptimizingForSize(Level))
364 FPM.addPass(LibCallsShrinkWrapPass());
365
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000366 invokePeepholeEPCallbacks(FPM, Level);
367
Rong Xue1f42452017-10-23 22:21:29 +0000368 // For PGO use pipeline, try to optimize memory intrinsics such as memcpy
369 // using the size value profile. Don't perform this when optimizing for size.
370 if (PGOOpt && !PGOOpt->ProfileUseFile.empty() &&
371 !isOptimizingForSize(Level))
372 FPM.addPass(PGOMemOPSizeOpt());
373
Chandler Carruthe3f50642016-12-22 06:59:15 +0000374 FPM.addPass(TailCallElimPass());
375 FPM.addPass(SimplifyCFGPass());
376
377 // Form canonically associated expression trees, and simplify the trees using
378 // basic mathematical properties. For example, this will form (nearly)
379 // minimal multiplication trees.
380 FPM.addPass(ReassociatePass());
381
382 // Add the primary loop simplification pipeline.
383 // FIXME: Currently this is split into two loop pass pipelines because we run
384 // some function passes in between them. These can and should be replaced by
385 // loop pass equivalenst but those aren't ready yet. Specifically,
386 // `SimplifyCFGPass` and `InstCombinePass` are used. We have
387 // `LoopSimplifyCFGPass` which isn't yet powerful enough, and the closest to
388 // the other we have is `LoopInstSimplify`.
389 LoopPassManager LPM1(DebugLogging), LPM2(DebugLogging);
390
391 // Rotate Loop - disable header duplication at -Oz
392 LPM1.addPass(LoopRotatePass(Level != Oz));
393 LPM1.addPass(LICMPass());
Chandler Carruth86248d52017-05-26 01:24:11 +0000394 LPM1.addPass(SimpleLoopUnswitchPass());
Chandler Carruth79b733b2017-01-26 23:21:17 +0000395 LPM2.addPass(IndVarSimplifyPass());
396 LPM2.addPass(LoopIdiomRecognizePass());
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000397
398 for (auto &C : LateLoopOptimizationsEPCallbacks)
399 C(LPM2, Level);
400
Chandler Carruth79b733b2017-01-26 23:21:17 +0000401 LPM2.addPass(LoopDeletionPass());
Dehao Chen95f00302017-07-30 04:55:39 +0000402 // Do not enable unrolling in PreLinkThinLTO phase during sample PGO
Dehao Chen3a9861422017-07-07 20:53:10 +0000403 // because it changes IR to makes profile annotation in back compile
404 // inaccurate.
Dehao Chen95f00302017-07-30 04:55:39 +0000405 if (Phase != ThinLTOPhase::PreLink ||
406 !PGOOpt || PGOOpt->SampleProfileFile.empty())
Teresa Johnsonecd90132017-08-02 20:35:29 +0000407 LPM2.addPass(LoopFullUnrollPass(Level));
Chandler Carruth79b733b2017-01-26 23:21:17 +0000408
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000409 for (auto &C : LoopOptimizerEndEPCallbacks)
410 C(LPM2, Level);
411
Chandler Carruth0ede22e2017-02-09 23:54:57 +0000412 // We provide the opt remark emitter pass for LICM to use. We only need to do
413 // this once as it is immutable.
414 FPM.addPass(RequireAnalysisPass<OptimizationRemarkEmitterAnalysis, Function>());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000415 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM1)));
416 FPM.addPass(SimplifyCFGPass());
417 FPM.addPass(InstCombinePass());
418 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM2)));
419
420 // Eliminate redundancies.
421 if (Level != O1) {
422 // These passes add substantial compile time so skip them at O1.
423 FPM.addPass(MergedLoadStoreMotionPass());
Davide Italiano8a09b8e2017-05-22 23:41:40 +0000424 if (RunNewGVN)
425 FPM.addPass(NewGVNPass());
426 else
427 FPM.addPass(GVN());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000428 }
429
430 // Specially optimize memory movement as it doesn't look like dataflow in SSA.
431 FPM.addPass(MemCpyOptPass());
432
433 // Sparse conditional constant propagation.
434 // FIXME: It isn't clear why we do this *after* loop passes rather than
435 // before...
436 FPM.addPass(SCCPPass());
437
438 // Delete dead bit computations (instcombine runs after to fold away the dead
439 // computations, and then ADCE will run later to exploit any new DCE
440 // opportunities that creates).
441 FPM.addPass(BDCEPass());
442
443 // Run instcombine after redundancy and dead bit elimination to exploit
444 // opportunities opened up by them.
445 FPM.addPass(InstCombinePass());
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000446 invokePeepholeEPCallbacks(FPM, Level);
Chandler Carruthe3f50642016-12-22 06:59:15 +0000447
448 // Re-consider control flow based optimizations after redundancy elimination,
449 // redo DCE, etc.
450 FPM.addPass(JumpThreadingPass());
451 FPM.addPass(CorrelatedValuePropagationPass());
452 FPM.addPass(DSEPass());
453 FPM.addPass(createFunctionToLoopPassAdaptor(LICMPass()));
454
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000455 for (auto &C : ScalarOptimizerLateEPCallbacks)
456 C(FPM, Level);
457
Chandler Carruthe3f50642016-12-22 06:59:15 +0000458 // Finally, do an expensive DCE pass to catch all the dead code exposed by
459 // the simplifications and basic cleanup after all the simplifications.
460 FPM.addPass(ADCEPass());
461 FPM.addPass(SimplifyCFGPass());
462 FPM.addPass(InstCombinePass());
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000463 invokePeepholeEPCallbacks(FPM, Level);
Chandler Carruthe3f50642016-12-22 06:59:15 +0000464
465 return FPM;
466}
467
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000468void PassBuilder::addPGOInstrPasses(ModulePassManager &MPM, bool DebugLogging,
469 PassBuilder::OptimizationLevel Level,
470 bool RunProfileGen,
471 std::string ProfileGenFile,
472 std::string ProfileUseFile) {
Davide Italiano513dfaa2017-02-13 15:26:22 +0000473 // Generally running simplification passes and the inliner with an high
474 // threshold results in smaller executables, but there may be cases where
475 // the size grows, so let's be conservative here and skip this simplification
476 // at -Os/Oz.
477 if (!isOptimizingForSize(Level)) {
478 InlineParams IP;
479
480 // In the old pass manager, this is a cl::opt. Should still this be one?
481 IP.DefaultThreshold = 75;
482
483 // FIXME: The hint threshold has the same value used by the regular inliner.
484 // This should probably be lowered after performance testing.
485 // FIXME: this comment is cargo culted from the old pass manager, revisit).
486 IP.HintThreshold = 325;
487
488 CGSCCPassManager CGPipeline(DebugLogging);
489
490 CGPipeline.addPass(InlinerPass(IP));
491
492 FunctionPassManager FPM;
493 FPM.addPass(SROA());
494 FPM.addPass(EarlyCSEPass()); // Catch trivial redundancies.
495 FPM.addPass(SimplifyCFGPass()); // Merge & remove basic blocks.
496 FPM.addPass(InstCombinePass()); // Combine silly sequences.
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000497 invokePeepholeEPCallbacks(FPM, Level);
Davide Italiano513dfaa2017-02-13 15:26:22 +0000498
Davide Italiano513dfaa2017-02-13 15:26:22 +0000499 CGPipeline.addPass(createCGSCCToFunctionPassAdaptor(std::move(FPM)));
500
501 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPipeline)));
502 }
503
Chandler Carruthf4d62c42017-05-25 07:15:09 +0000504 // Delete anything that is now dead to make sure that we don't instrument
505 // dead code. Instrumentation can end up keeping dead code around and
506 // dramatically increase code size.
507 MPM.addPass(GlobalDCEPass());
508
Davide Italiano513dfaa2017-02-13 15:26:22 +0000509 if (RunProfileGen) {
510 MPM.addPass(PGOInstrumentationGen());
511
Xinliang David Lib67530e2017-06-25 00:26:43 +0000512 FunctionPassManager FPM;
513 FPM.addPass(createFunctionToLoopPassAdaptor(LoopRotatePass()));
514 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
515
Davide Italiano513dfaa2017-02-13 15:26:22 +0000516 // Add the profile lowering pass.
517 InstrProfOptions Options;
518 if (!ProfileGenFile.empty())
519 Options.InstrProfileOutput = ProfileGenFile;
Xinliang David Lib67530e2017-06-25 00:26:43 +0000520 Options.DoCounterPromotion = true;
Davide Italiano513dfaa2017-02-13 15:26:22 +0000521 MPM.addPass(InstrProfiling(Options));
522 }
523
524 if (!ProfileUseFile.empty())
525 MPM.addPass(PGOInstrumentationUse(ProfileUseFile));
526}
527
Easwaran Raman8249fac2017-06-28 13:33:49 +0000528static InlineParams
529getInlineParamsFromOptLevel(PassBuilder::OptimizationLevel Level) {
530 auto O3 = PassBuilder::O3;
531 unsigned OptLevel = Level > O3 ? 2 : Level;
532 unsigned SizeLevel = Level > O3 ? Level - O3 : 0;
533 return getInlineParams(OptLevel, SizeLevel);
534}
535
Chandler Carruthe3f50642016-12-22 06:59:15 +0000536ModulePassManager
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000537PassBuilder::buildModuleSimplificationPipeline(OptimizationLevel Level,
Dehao Chen95f00302017-07-30 04:55:39 +0000538 ThinLTOPhase Phase,
539 bool DebugLogging) {
Chandler Carruthe3f50642016-12-22 06:59:15 +0000540 ModulePassManager MPM(DebugLogging);
541
Chandler Carruthe3f50642016-12-22 06:59:15 +0000542 // Do basic inference of function attributes from known properties of system
543 // libraries and other oracles.
544 MPM.addPass(InferFunctionAttrsPass());
545
546 // Create an early function pass manager to cleanup the output of the
547 // frontend.
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000548 FunctionPassManager EarlyFPM(DebugLogging);
549 EarlyFPM.addPass(SimplifyCFGPass());
550 EarlyFPM.addPass(SROA());
551 EarlyFPM.addPass(EarlyCSEPass());
552 EarlyFPM.addPass(LowerExpectIntrinsicPass());
Jun Bum Lim0c990072017-11-03 20:41:16 +0000553 if (Level == O3)
554 EarlyFPM.addPass(CallSiteSplittingPass());
555
Dehao Chen08f88312017-08-07 20:23:20 +0000556 // In SamplePGO ThinLTO backend, we need instcombine before profile annotation
557 // to convert bitcast to direct calls so that they can be inlined during the
558 // profile annotation prepration step.
559 // More details about SamplePGO design can be found in:
560 // https://research.google.com/pubs/pub45290.html
561 // FIXME: revisit how SampleProfileLoad/Inliner/ICP is structured.
562 if (PGOOpt && !PGOOpt->SampleProfileFile.empty() &&
563 Phase == ThinLTOPhase::PostLink)
564 EarlyFPM.addPass(InstCombinePass());
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000565 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(EarlyFPM)));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000566
Dehao Chen08f88312017-08-07 20:23:20 +0000567 if (PGOOpt && !PGOOpt->SampleProfileFile.empty()) {
568 // Annotate sample profile right after early FPM to ensure freshness of
569 // the debug info.
Dehao Chend26dae02017-10-01 05:24:51 +0000570 MPM.addPass(SampleProfileLoaderPass(PGOOpt->SampleProfileFile,
571 Phase == ThinLTOPhase::PreLink));
Dehao Chen08f88312017-08-07 20:23:20 +0000572 // Do not invoke ICP in the ThinLTOPrelink phase as it makes it hard
573 // for the profile annotation to be accurate in the ThinLTO backend.
574 if (Phase != ThinLTOPhase::PreLink)
575 // We perform early indirect call promotion here, before globalopt.
576 // This is important for the ThinLTO backend phase because otherwise
577 // imported available_externally functions look unreferenced and are
578 // removed.
579 MPM.addPass(PGOIndirectCallPromotion(Phase == ThinLTOPhase::PostLink,
580 true));
581 }
582
Chandler Carruthe3f50642016-12-22 06:59:15 +0000583 // Interprocedural constant propagation now that basic cleanup has occured
584 // and prior to optimizing globals.
585 // FIXME: This position in the pipeline hasn't been carefully considered in
586 // years, it should be re-analyzed.
587 MPM.addPass(IPSCCPPass());
588
Matthew Simpsoncb585582017-10-25 13:40:08 +0000589 // Attach metadata to indirect call sites indicating the set of functions
590 // they may target at run-time. This should follow IPSCCP.
591 MPM.addPass(CalledValuePropagationPass());
592
Chandler Carruthe3f50642016-12-22 06:59:15 +0000593 // Optimize globals to try and fold them into constants.
594 MPM.addPass(GlobalOptPass());
595
596 // Promote any localized globals to SSA registers.
597 // FIXME: Should this instead by a run of SROA?
598 // FIXME: We should probably run instcombine and simplify-cfg afterward to
599 // delete control flows that are dead once globals have been folded to
600 // constants.
601 MPM.addPass(createModuleToFunctionPassAdaptor(PromotePass()));
602
603 // Remove any dead arguments exposed by cleanups and constand folding
604 // globals.
605 MPM.addPass(DeadArgumentEliminationPass());
606
607 // Create a small function pass pipeline to cleanup after all the global
608 // optimizations.
609 FunctionPassManager GlobalCleanupPM(DebugLogging);
610 GlobalCleanupPM.addPass(InstCombinePass());
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000611 invokePeepholeEPCallbacks(GlobalCleanupPM, Level);
612
Chandler Carruthe3f50642016-12-22 06:59:15 +0000613 GlobalCleanupPM.addPass(SimplifyCFGPass());
614 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(GlobalCleanupPM)));
615
Dehao Chen89d32262017-08-02 01:28:31 +0000616 // Add all the requested passes for instrumentation PGO, if requested.
617 if (PGOOpt && Phase != ThinLTOPhase::PostLink &&
618 (!PGOOpt->ProfileGenFile.empty() || !PGOOpt->ProfileUseFile.empty())) {
619 addPGOInstrPasses(MPM, DebugLogging, Level, PGOOpt->RunProfileGen,
620 PGOOpt->ProfileGenFile, PGOOpt->ProfileUseFile);
621 MPM.addPass(PGOIndirectCallPromotion(false, false));
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000622 }
Davide Italiano513dfaa2017-02-13 15:26:22 +0000623
Chandler Carruthe87fc8c2017-02-12 05:34:04 +0000624 // Require the GlobalsAA analysis for the module so we can query it within
625 // the CGSCC pipeline.
626 MPM.addPass(RequireAnalysisPass<GlobalsAA, Module>());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000627
Easwaran Raman5e6f9bd2017-05-04 16:58:45 +0000628 // Require the ProfileSummaryAnalysis for the module so we can query it within
629 // the inliner pass.
630 MPM.addPass(RequireAnalysisPass<ProfileSummaryAnalysis, Module>());
631
Chandler Carruthe3f50642016-12-22 06:59:15 +0000632 // Now begin the main postorder CGSCC pipeline.
633 // FIXME: The current CGSCC pipeline has its origins in the legacy pass
634 // manager and trying to emulate its precise behavior. Much of this doesn't
635 // make a lot of sense and we should revisit the core CGSCC structure.
636 CGSCCPassManager MainCGPipeline(DebugLogging);
637
638 // Note: historically, the PruneEH pass was run first to deduce nounwind and
639 // generally clean up exception handling overhead. It isn't clear this is
640 // valuable as the inliner doesn't currently care whether it is inlining an
641 // invoke or a call.
642
643 // Run the inliner first. The theory is that we are walking bottom-up and so
644 // the callees have already been fully optimized, and we want to inline them
645 // into the callers so that our optimizations can reflect that.
Dehao Chen95f00302017-07-30 04:55:39 +0000646 // For PreLinkThinLTO pass, we disable hot-caller heuristic for sample PGO
Dehao Chen3a9861422017-07-07 20:53:10 +0000647 // because it makes profile annotation in the backend inaccurate.
648 InlineParams IP = getInlineParamsFromOptLevel(Level);
Dehao Chen95f00302017-07-30 04:55:39 +0000649 if (Phase == ThinLTOPhase::PreLink &&
650 PGOOpt && !PGOOpt->SampleProfileFile.empty())
Dehao Chen3a9861422017-07-07 20:53:10 +0000651 IP.HotCallSiteThreshold = 0;
652 MainCGPipeline.addPass(InlinerPass(IP));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000653
654 // Now deduce any function attributes based in the current code.
655 MainCGPipeline.addPass(PostOrderFunctionAttrsPass());
656
Chandler Carruth0ede22e2017-02-09 23:54:57 +0000657 // When at O3 add argument promotion to the pass pipeline.
658 // FIXME: It isn't at all clear why this should be limited to O3.
659 if (Level == O3)
660 MainCGPipeline.addPass(ArgumentPromotionPass());
661
Chandler Carruthe3f50642016-12-22 06:59:15 +0000662 // Lastly, add the core function simplification pipeline nested inside the
663 // CGSCC walk.
664 MainCGPipeline.addPass(createCGSCCToFunctionPassAdaptor(
Dehao Chen95f00302017-07-30 04:55:39 +0000665 buildFunctionSimplificationPipeline(Level, Phase, DebugLogging)));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000666
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000667 for (auto &C : CGSCCOptimizerLateEPCallbacks)
668 C(MainCGPipeline, Level);
669
Chandler Carruth719ffe12017-02-12 05:38:04 +0000670 // We wrap the CGSCC pipeline in a devirtualization repeater. This will try
671 // to detect when we devirtualize indirect calls and iterate the SCC passes
672 // in that case to try and catch knock-on inlining or function attrs
673 // opportunities. Then we add it to the module pipeline by walking the SCCs
674 // in postorder (or bottom-up).
Chandler Carruthe3f50642016-12-22 06:59:15 +0000675 MPM.addPass(
Chandler Carruth719ffe12017-02-12 05:38:04 +0000676 createModuleToPostOrderCGSCCPassAdaptor(createDevirtSCCRepeatedPass(
Chandler Carruth19913b22017-08-11 05:47:13 +0000677 std::move(MainCGPipeline), MaxDevirtIterations)));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000678
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000679 return MPM;
680}
681
682ModulePassManager
683PassBuilder::buildModuleOptimizationPipeline(OptimizationLevel Level,
684 bool DebugLogging) {
685 ModulePassManager MPM(DebugLogging);
686
687 // Optimize globals now that the module is fully simplified.
688 MPM.addPass(GlobalOptPass());
Davide Italianoe0707212017-10-05 18:36:01 +0000689 MPM.addPass(GlobalDCEPass());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000690
Xinliang David Li126157c2017-05-22 16:41:57 +0000691 // Run partial inlining pass to partially inline functions that have
692 // large bodies.
693 if (RunPartialInlining)
694 MPM.addPass(PartialInlinerPass());
695
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000696 // Remove avail extern fns and globals definitions since we aren't compiling
697 // an object file for later LTO. For LTO we want to preserve these so they
698 // are eligible for inlining at link-time. Note if they are unreferenced they
699 // will be removed by GlobalDCE later, so this only impacts referenced
700 // available externally globals. Eventually they will be suppressed during
701 // codegen, but eliminating here enables more opportunity for GlobalDCE as it
702 // may make globals referenced by available external functions dead and saves
703 // running remaining passes on the eliminated functions.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000704 MPM.addPass(EliminateAvailableExternallyPass());
705
706 // Do RPO function attribute inference across the module to forward-propagate
707 // attributes where applicable.
708 // FIXME: Is this really an optimization rather than a canonicalization?
709 MPM.addPass(ReversePostOrderFunctionAttrsPass());
710
Chandler Carruthe87fc8c2017-02-12 05:34:04 +0000711 // Re-require GloblasAA here prior to function passes. This is particularly
Chandler Carruthe3f50642016-12-22 06:59:15 +0000712 // useful as the above will have inlined, DCE'ed, and function-attr
713 // propagated everything. We should at this point have a reasonably minimal
714 // and richly annotated call graph. By computing aliasing and mod/ref
715 // information for all local globals here, the late loop passes and notably
716 // the vectorizer will be able to use them to help recognize vectorizable
717 // memory operations.
Chandler Carruthe87fc8c2017-02-12 05:34:04 +0000718 MPM.addPass(RequireAnalysisPass<GlobalsAA, Module>());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000719
720 FunctionPassManager OptimizePM(DebugLogging);
721 OptimizePM.addPass(Float2IntPass());
722 // FIXME: We need to run some loop optimizations to re-rotate loops after
723 // simplify-cfg and others undo their rotation.
724
725 // Optimize the loop execution. These passes operate on entire loop nests
726 // rather than on each loop in an inside-out manner, and so they are actually
727 // function passes.
Chandler Carrutha95ff382017-01-27 00:50:21 +0000728
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000729 for (auto &C : VectorizerStartEPCallbacks)
730 C(OptimizePM, Level);
731
Chandler Carrutha95ff382017-01-27 00:50:21 +0000732 // First rotate loops that may have been un-rotated by prior passes.
733 OptimizePM.addPass(createFunctionToLoopPassAdaptor(LoopRotatePass()));
734
735 // Distribute loops to allow partial vectorization. I.e. isolate dependences
736 // into separate loop that would otherwise inhibit vectorization. This is
737 // currently only performed for loops marked with the metadata
738 // llvm.loop.distribute=true or when -enable-loop-distribute is specified.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000739 OptimizePM.addPass(LoopDistributePass());
Chandler Carrutha95ff382017-01-27 00:50:21 +0000740
741 // Now run the core loop vectorizer.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000742 OptimizePM.addPass(LoopVectorizePass());
Chandler Carrutha95ff382017-01-27 00:50:21 +0000743
Chandler Carruthbaabda92017-01-27 01:32:26 +0000744 // Eliminate loads by forwarding stores from the previous iteration to loads
745 // of the current iteration.
746 OptimizePM.addPass(LoopLoadEliminationPass());
Chandler Carrutha95ff382017-01-27 00:50:21 +0000747
748 // Cleanup after the loop optimization passes.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000749 OptimizePM.addPass(InstCombinePass());
750
Chandler Carrutha95ff382017-01-27 00:50:21 +0000751
752 // Now that we've formed fast to execute loop structures, we do further
753 // optimizations. These are run afterward as they might block doing complex
754 // analyses and transforms such as what are needed for loop vectorization.
755
Chandler Carruthe3f50642016-12-22 06:59:15 +0000756 // Optimize parallel scalar instruction chains into SIMD instructions.
757 OptimizePM.addPass(SLPVectorizerPass());
758
David L. Jones82b22e02017-11-06 00:32:01 +0000759 // Cleanup after all of the vectorizers.
760 OptimizePM.addPass(SimplifyCFGPass());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000761 OptimizePM.addPass(InstCombinePass());
762
763 // Unroll small loops to hide loop backedge latency and saturate any parallel
Chandler Carrutha95ff382017-01-27 00:50:21 +0000764 // execution resources of an out-of-order processor. We also then need to
765 // clean up redundancies and loop invariant code.
766 // FIXME: It would be really good to use a loop-integrated instruction
767 // combiner for cleanup here so that the unrolling and LICM can be pipelined
768 // across the loop nests.
Teresa Johnsonecd90132017-08-02 20:35:29 +0000769 OptimizePM.addPass(LoopUnrollPass(Level));
Chandler Carrutha95ff382017-01-27 00:50:21 +0000770 OptimizePM.addPass(InstCombinePass());
Chandler Carruth0ede22e2017-02-09 23:54:57 +0000771 OptimizePM.addPass(RequireAnalysisPass<OptimizationRemarkEmitterAnalysis, Function>());
Chandler Carrutha95ff382017-01-27 00:50:21 +0000772 OptimizePM.addPass(createFunctionToLoopPassAdaptor(LICMPass()));
Chandler Carruthe3f50642016-12-22 06:59:15 +0000773
774 // Now that we've vectorized and unrolled loops, we may have more refined
775 // alignment information, try to re-derive it here.
776 OptimizePM.addPass(AlignmentFromAssumptionsPass());
777
Chandler Carrutha95ff382017-01-27 00:50:21 +0000778 // LoopSink pass sinks instructions hoisted by LICM, which serves as a
779 // canonicalization pass that enables other optimizations. As a result,
780 // LoopSink pass needs to be a very late IR pass to avoid undoing LICM
781 // result too early.
782 OptimizePM.addPass(LoopSinkPass());
783
784 // And finally clean up LCSSA form before generating code.
785 OptimizePM.addPass(InstSimplifierPass());
786
Sanjay Patel6fd43912017-09-09 13:38:18 +0000787 // This hoists/decomposes div/rem ops. It should run after other sink/hoist
788 // passes to avoid re-sinking, but before SimplifyCFG because it can allow
789 // flattening of blocks.
790 OptimizePM.addPass(DivRemPairsPass());
791
Filipe Cabecinhas92dc3482017-04-26 12:02:41 +0000792 // LoopSink (and other loop passes since the last simplifyCFG) might have
793 // resulted in single-entry-single-exit or empty blocks. Clean up the CFG.
794 OptimizePM.addPass(SimplifyCFGPass());
795
Chandler Carrutha95ff382017-01-27 00:50:21 +0000796 // Add the core optimizing pipeline.
Chandler Carruthe3f50642016-12-22 06:59:15 +0000797 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(OptimizePM)));
798
799 // Now we need to do some global optimization transforms.
800 // FIXME: It would seem like these should come first in the optimization
801 // pipeline and maybe be the bottom of the canonicalization pipeline? Weird
802 // ordering here.
803 MPM.addPass(GlobalDCEPass());
804 MPM.addPass(ConstantMergePass());
805
806 return MPM;
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000807}
808
Chandler Carruthe3f50642016-12-22 06:59:15 +0000809ModulePassManager
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000810PassBuilder::buildPerModuleDefaultPipeline(OptimizationLevel Level,
811 bool DebugLogging) {
812 assert(Level != O0 && "Must request optimizations for the default pipeline!");
813
814 ModulePassManager MPM(DebugLogging);
815
816 // Force any function attributes we want the rest of the pipeline to observe.
817 MPM.addPass(ForceFunctionAttrsPass());
818
Dehao Chen08f88312017-08-07 20:23:20 +0000819 if (PGOOpt && PGOOpt->SamplePGOSupport)
Dehao Chence0842c2017-07-29 04:10:24 +0000820 MPM.addPass(createModuleToFunctionPassAdaptor(AddDiscriminatorsPass()));
821
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000822 // Add the core simplification pipeline.
Dehao Chen95f00302017-07-30 04:55:39 +0000823 MPM.addPass(buildModuleSimplificationPipeline(Level, ThinLTOPhase::None,
824 DebugLogging));
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000825
826 // Now add the optimization pipeline.
827 MPM.addPass(buildModuleOptimizationPipeline(Level, DebugLogging));
828
829 return MPM;
830}
831
832ModulePassManager
833PassBuilder::buildThinLTOPreLinkDefaultPipeline(OptimizationLevel Level,
834 bool DebugLogging) {
835 assert(Level != O0 && "Must request optimizations for the default pipeline!");
836
837 ModulePassManager MPM(DebugLogging);
838
839 // Force any function attributes we want the rest of the pipeline to observe.
840 MPM.addPass(ForceFunctionAttrsPass());
841
Dehao Chen08f88312017-08-07 20:23:20 +0000842 if (PGOOpt && PGOOpt->SamplePGOSupport)
Dehao Chence0842c2017-07-29 04:10:24 +0000843 MPM.addPass(createModuleToFunctionPassAdaptor(AddDiscriminatorsPass()));
844
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000845 // If we are planning to perform ThinLTO later, we don't bloat the code with
846 // unrolling/vectorization/... now. Just simplify the module as much as we
847 // can.
Dehao Chen95f00302017-07-30 04:55:39 +0000848 MPM.addPass(buildModuleSimplificationPipeline(Level, ThinLTOPhase::PreLink,
849 DebugLogging));
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000850
851 // Run partial inlining pass to partially inline functions that have
852 // large bodies.
853 // FIXME: It isn't clear whether this is really the right place to run this
854 // in ThinLTO. Because there is another canonicalization and simplification
855 // phase that will run after the thin link, running this here ends up with
856 // less information than will be available later and it may grow functions in
857 // ways that aren't beneficial.
858 if (RunPartialInlining)
859 MPM.addPass(PartialInlinerPass());
860
861 // Reduce the size of the IR as much as possible.
862 MPM.addPass(GlobalOptPass());
863
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000864 return MPM;
865}
866
867ModulePassManager
868PassBuilder::buildThinLTODefaultPipeline(OptimizationLevel Level,
869 bool DebugLogging) {
870 // FIXME: The summary index is not hooked in the new pass manager yet.
871 // When it's going to be hooked, enable WholeProgramDevirt and LowerTypeTest
872 // here.
873
874 ModulePassManager MPM(DebugLogging);
875
876 // Force any function attributes we want the rest of the pipeline to observe.
877 MPM.addPass(ForceFunctionAttrsPass());
878
879 // During the ThinLTO backend phase we perform early indirect call promotion
880 // here, before globalopt. Otherwise imported available_externally functions
881 // look unreferenced and are removed.
Dehao Chen08f88312017-08-07 20:23:20 +0000882 // FIXME: move this into buildModuleSimplificationPipeline to merge the logic
883 // with SamplePGO.
Dehao Chen2f4e2e22017-08-10 05:10:32 +0000884 if (!PGOOpt || PGOOpt->SampleProfileFile.empty())
Dehao Chen08f88312017-08-07 20:23:20 +0000885 MPM.addPass(PGOIndirectCallPromotion(true /* InLTO */,
886 false /* SamplePGO */));
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000887
888 // Add the core simplification pipeline.
Dehao Chen95f00302017-07-30 04:55:39 +0000889 MPM.addPass(buildModuleSimplificationPipeline(Level, ThinLTOPhase::PostLink,
890 DebugLogging));
Chandler Carruth8b3be4e2017-06-01 11:39:39 +0000891
892 // Now add the optimization pipeline.
893 MPM.addPass(buildModuleOptimizationPipeline(Level, DebugLogging));
894
895 return MPM;
896}
897
898ModulePassManager
Chandler Carruthe3f50642016-12-22 06:59:15 +0000899PassBuilder::buildLTOPreLinkDefaultPipeline(OptimizationLevel Level,
900 bool DebugLogging) {
901 assert(Level != O0 && "Must request optimizations for the default pipeline!");
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000902 // FIXME: We should use a customized pre-link pipeline!
Chandler Carruthe3f50642016-12-22 06:59:15 +0000903 return buildPerModuleDefaultPipeline(Level, DebugLogging);
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000904}
905
Chandler Carruthe3f50642016-12-22 06:59:15 +0000906ModulePassManager PassBuilder::buildLTODefaultPipeline(OptimizationLevel Level,
907 bool DebugLogging) {
908 assert(Level != O0 && "Must request optimizations for the default pipeline!");
909 ModulePassManager MPM(DebugLogging);
910
Davide Italiano089a9122017-01-24 00:57:39 +0000911 // Remove unused virtual tables to improve the quality of code generated by
912 // whole-program devirtualization and bitset lowering.
913 MPM.addPass(GlobalDCEPass());
Chandler Carruth8b5a74192016-02-28 22:16:03 +0000914
Davide Italiano089a9122017-01-24 00:57:39 +0000915 // Force any function attributes we want the rest of the pipeline to observe.
916 MPM.addPass(ForceFunctionAttrsPass());
Chandler Carruthe3f50642016-12-22 06:59:15 +0000917
Davide Italiano089a9122017-01-24 00:57:39 +0000918 // Do basic inference of function attributes from known properties of system
919 // libraries and other oracles.
920 MPM.addPass(InferFunctionAttrsPass());
921
922 if (Level > 1) {
Jun Bum Lim0c990072017-11-03 20:41:16 +0000923 FunctionPassManager EarlyFPM(DebugLogging);
924 EarlyFPM.addPass(CallSiteSplittingPass());
925 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(EarlyFPM)));
926
Davide Italiano089a9122017-01-24 00:57:39 +0000927 // Indirect call promotion. This should promote all the targets that are
928 // left by the earlier promotion pass that promotes intra-module targets.
929 // This two-step promotion is to save the compile time. For LTO, it should
930 // produce the same result as if we only do promotion here.
Dehao Chen2f31d0d2017-06-29 23:33:05 +0000931 MPM.addPass(PGOIndirectCallPromotion(
932 true /* InLTO */, PGOOpt && !PGOOpt->SampleProfileFile.empty()));
Davide Italiano089a9122017-01-24 00:57:39 +0000933 // Propagate constants at call sites into the functions they call. This
934 // opens opportunities for globalopt (and inlining) by substituting function
935 // pointers passed as arguments to direct uses of functions.
936 MPM.addPass(IPSCCPPass());
Matthew Simpsoncb585582017-10-25 13:40:08 +0000937
938 // Attach metadata to indirect call sites indicating the set of functions
939 // they may target at run-time. This should follow IPSCCP.
940 MPM.addPass(CalledValuePropagationPass());
Davide Italiano089a9122017-01-24 00:57:39 +0000941 }
942
943 // Now deduce any function attributes based in the current code.
944 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(
945 PostOrderFunctionAttrsPass()));
946
947 // Do RPO function attribute inference across the module to forward-propagate
948 // attributes where applicable.
949 // FIXME: Is this really an optimization rather than a canonicalization?
950 MPM.addPass(ReversePostOrderFunctionAttrsPass());
951
952 // Use inragne annotations on GEP indices to split globals where beneficial.
953 MPM.addPass(GlobalSplitPass());
954
955 // Run whole program optimization of virtual call when the list of callees
956 // is fixed.
957 MPM.addPass(WholeProgramDevirtPass());
958
959 // Stop here at -O1.
960 if (Level == 1)
961 return MPM;
962
963 // Optimize globals to try and fold them into constants.
964 MPM.addPass(GlobalOptPass());
965
966 // Promote any localized globals to SSA registers.
967 MPM.addPass(createModuleToFunctionPassAdaptor(PromotePass()));
968
969 // Linking modules together can lead to duplicate global constant, only
970 // keep one copy of each constant.
971 MPM.addPass(ConstantMergePass());
972
973 // Remove unused arguments from functions.
974 MPM.addPass(DeadArgumentEliminationPass());
975
976 // Reduce the code after globalopt and ipsccp. Both can open up significant
977 // simplification opportunities, and both can propagate functions through
978 // function pointers. When this happens, we often have to resolve varargs
979 // calls, etc, so let instcombine do this.
Philip Pfaffe730f2f92017-07-10 10:57:55 +0000980 FunctionPassManager PeepholeFPM(DebugLogging);
981 PeepholeFPM.addPass(InstCombinePass());
982 invokePeepholeEPCallbacks(PeepholeFPM, Level);
983
984 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(PeepholeFPM)));
Davide Italiano089a9122017-01-24 00:57:39 +0000985
986 // Note: historically, the PruneEH pass was run first to deduce nounwind and
987 // generally clean up exception handling overhead. It isn't clear this is
988 // valuable as the inliner doesn't currently care whether it is inlining an
989 // invoke or a call.
990 // Run the inliner now.
Easwaran Raman8249fac2017-06-28 13:33:49 +0000991 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(
992 InlinerPass(getInlineParamsFromOptLevel(Level))));
Davide Italiano089a9122017-01-24 00:57:39 +0000993
994 // Optimize globals again after we ran the inliner.
995 MPM.addPass(GlobalOptPass());
996
997 // Garbage collect dead functions.
998 // FIXME: Add ArgumentPromotion pass after once it's ported.
999 MPM.addPass(GlobalDCEPass());
1000
1001 FunctionPassManager FPM(DebugLogging);
Davide Italiano089a9122017-01-24 00:57:39 +00001002 // The IPO Passes may leave cruft around. Clean up after them.
Davide Italiano089a9122017-01-24 00:57:39 +00001003 FPM.addPass(InstCombinePass());
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001004 invokePeepholeEPCallbacks(FPM, Level);
1005
Davide Italiano089a9122017-01-24 00:57:39 +00001006 FPM.addPass(JumpThreadingPass());
1007
1008 // Break up allocas
1009 FPM.addPass(SROA());
1010
1011 // Run a few AA driver optimizations here and now to cleanup the code.
1012 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
1013
1014 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(
1015 PostOrderFunctionAttrsPass()));
1016 // FIXME: here we run IP alias analysis in the legacy PM.
1017
1018 FunctionPassManager MainFPM;
1019
1020 // FIXME: once we fix LoopPass Manager, add LICM here.
1021 // FIXME: once we provide support for enabling MLSM, add it here.
1022 // FIXME: once we provide support for enabling NewGVN, add it here.
Davide Italiano8a09b8e2017-05-22 23:41:40 +00001023 if (RunNewGVN)
1024 MainFPM.addPass(NewGVNPass());
1025 else
1026 MainFPM.addPass(GVN());
Davide Italiano089a9122017-01-24 00:57:39 +00001027
1028 // Remove dead memcpy()'s.
1029 MainFPM.addPass(MemCpyOptPass());
1030
1031 // Nuke dead stores.
1032 MainFPM.addPass(DSEPass());
1033
1034 // FIXME: at this point, we run a bunch of loop passes:
1035 // indVarSimplify, loopDeletion, loopInterchange, loopUnrool,
1036 // loopVectorize. Enable them once the remaining issue with LPM
1037 // are sorted out.
1038
1039 MainFPM.addPass(InstCombinePass());
1040 MainFPM.addPass(SimplifyCFGPass());
1041 MainFPM.addPass(SCCPPass());
1042 MainFPM.addPass(InstCombinePass());
1043 MainFPM.addPass(BDCEPass());
1044
1045 // FIXME: We may want to run SLPVectorizer here.
1046 // After vectorization, assume intrinsics may tell us more
1047 // about pointer alignments.
1048#if 0
1049 MainFPM.add(AlignmentFromAssumptionsPass());
1050#endif
1051
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001052 // FIXME: Conditionally run LoadCombine here, after it's ported
1053 // (in case we still have this pass, given its questionable usefulness).
1054
Davide Italiano089a9122017-01-24 00:57:39 +00001055 MainFPM.addPass(InstCombinePass());
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001056 invokePeepholeEPCallbacks(MainFPM, Level);
Davide Italiano089a9122017-01-24 00:57:39 +00001057 MainFPM.addPass(JumpThreadingPass());
1058 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(MainFPM)));
1059
1060 // Create a function that performs CFI checks for cross-DSO calls with
1061 // targets in the current module.
1062 MPM.addPass(CrossDSOCFIPass());
1063
1064 // Lower type metadata and the type.test intrinsic. This pass supports
1065 // clang's control flow integrity mechanisms (-fsanitize=cfi*) and needs
1066 // to be run at link time if CFI is enabled. This pass does nothing if
1067 // CFI is disabled.
1068 // Enable once we add support for the summary in the new PM.
1069#if 0
Peter Collingbourne857aba42017-02-09 21:45:01 +00001070 MPM.addPass(LowerTypeTestsPass(Summary ? PassSummaryAction::Export :
1071 PassSummaryAction::None,
Davide Italiano089a9122017-01-24 00:57:39 +00001072 Summary));
1073#endif
1074
1075 // Add late LTO optimization passes.
1076 // Delete basic blocks, which optimization passes may have killed.
1077 MPM.addPass(createModuleToFunctionPassAdaptor(SimplifyCFGPass()));
1078
1079 // Drop bodies of available eternally objects to improve GlobalDCE.
1080 MPM.addPass(EliminateAvailableExternallyPass());
1081
1082 // Now that we have optimized the program, discard unreachable functions.
1083 MPM.addPass(GlobalDCEPass());
1084
1085 // FIXME: Enable MergeFuncs, conditionally, after ported, maybe.
Chandler Carruthe3f50642016-12-22 06:59:15 +00001086 return MPM;
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001087}
1088
Chandler Carruth060ad612016-12-23 20:38:19 +00001089AAManager PassBuilder::buildDefaultAAPipeline() {
1090 AAManager AA;
1091
1092 // The order in which these are registered determines their priority when
1093 // being queried.
1094
1095 // First we register the basic alias analysis that provides the majority of
1096 // per-function local AA logic. This is a stateless, on-demand local set of
1097 // AA techniques.
1098 AA.registerFunctionAnalysis<BasicAA>();
1099
1100 // Next we query fast, specialized alias analyses that wrap IR-embedded
1101 // information about aliasing.
1102 AA.registerFunctionAnalysis<ScopedNoAliasAA>();
1103 AA.registerFunctionAnalysis<TypeBasedAA>();
1104
1105 // Add support for querying global aliasing information when available.
Chandler Carruth534d6442016-12-24 05:11:17 +00001106 // Because the `AAManager` is a function analysis and `GlobalsAA` is a module
1107 // analysis, all that the `AAManager` can do is query for any *cached*
Chandler Carruthe87fc8c2017-02-12 05:34:04 +00001108 // results from `GlobalsAA` through a readonly proxy.
Chandler Carruth060ad612016-12-23 20:38:19 +00001109 AA.registerModuleAnalysis<GlobalsAA>();
Chandler Carruth060ad612016-12-23 20:38:19 +00001110
1111 return AA;
1112}
1113
Chandler Carruth241bf242016-08-03 07:44:48 +00001114static Optional<int> parseRepeatPassName(StringRef Name) {
1115 if (!Name.consume_front("repeat<") || !Name.consume_back(">"))
1116 return None;
1117 int Count;
1118 if (Name.getAsInteger(0, Count) || Count <= 0)
1119 return None;
1120 return Count;
1121}
1122
Chandler Carruth05ca5ac2016-12-28 11:07:33 +00001123static Optional<int> parseDevirtPassName(StringRef Name) {
1124 if (!Name.consume_front("devirt<") || !Name.consume_back(">"))
1125 return None;
1126 int Count;
1127 if (Name.getAsInteger(0, Count) || Count <= 0)
1128 return None;
1129 return Count;
1130}
1131
Chandler Carruth8b3be4e2017-06-01 11:39:39 +00001132/// Tests whether a pass name starts with a valid prefix for a default pipeline
1133/// alias.
1134static bool startsWithDefaultPipelineAliasPrefix(StringRef Name) {
1135 return Name.startswith("default") || Name.startswith("thinlto") ||
1136 Name.startswith("lto");
1137}
1138
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001139/// Tests whether registered callbacks will accept a given pass name.
1140///
1141/// When parsing a pipeline text, the type of the outermost pipeline may be
1142/// omitted, in which case the type is automatically determined from the first
1143/// pass name in the text. This may be a name that is handled through one of the
1144/// callbacks. We check this through the oridinary parsing callbacks by setting
1145/// up a dummy PassManager in order to not force the client to also handle this
1146/// type of query.
1147template <typename PassManagerT, typename CallbacksT>
1148static bool callbacksAcceptPassName(StringRef Name, CallbacksT &Callbacks) {
1149 if (!Callbacks.empty()) {
1150 PassManagerT DummyPM;
1151 for (auto &CB : Callbacks)
1152 if (CB(Name, DummyPM, {}))
1153 return true;
1154 }
1155 return false;
1156}
1157
1158template <typename CallbacksT>
1159static bool isModulePassName(StringRef Name, CallbacksT &Callbacks) {
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001160 // Manually handle aliases for pre-configured pipeline fragments.
Chandler Carruth8b3be4e2017-06-01 11:39:39 +00001161 if (startsWithDefaultPipelineAliasPrefix(Name))
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001162 return DefaultAliasRegex.match(Name);
1163
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001164 // Explicitly handle pass manager names.
1165 if (Name == "module")
1166 return true;
1167 if (Name == "cgscc")
1168 return true;
1169 if (Name == "function")
1170 return true;
1171
Chandler Carruth241bf242016-08-03 07:44:48 +00001172 // Explicitly handle custom-parsed pass names.
1173 if (parseRepeatPassName(Name))
1174 return true;
1175
Chandler Carruth74a8a222016-06-17 07:15:29 +00001176#define MODULE_PASS(NAME, CREATE_PASS) \
1177 if (Name == NAME) \
1178 return true;
Chandler Carruth628503e2015-01-06 02:10:51 +00001179#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001180 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +00001181 return true;
1182#include "PassRegistry.def"
1183
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001184 return callbacksAcceptPassName<ModulePassManager>(Name, Callbacks);
Chandler Carruth66445382014-01-11 08:16:35 +00001185}
1186
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001187template <typename CallbacksT>
1188static bool isCGSCCPassName(StringRef Name, CallbacksT &Callbacks) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001189 // Explicitly handle pass manager names.
1190 if (Name == "cgscc")
1191 return true;
1192 if (Name == "function")
1193 return true;
1194
Chandler Carruth241bf242016-08-03 07:44:48 +00001195 // Explicitly handle custom-parsed pass names.
1196 if (parseRepeatPassName(Name))
1197 return true;
Chandler Carruth05ca5ac2016-12-28 11:07:33 +00001198 if (parseDevirtPassName(Name))
1199 return true;
Chandler Carruth241bf242016-08-03 07:44:48 +00001200
Chandler Carruth74a8a222016-06-17 07:15:29 +00001201#define CGSCC_PASS(NAME, CREATE_PASS) \
1202 if (Name == NAME) \
1203 return true;
Chandler Carruth628503e2015-01-06 02:10:51 +00001204#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001205 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +00001206 return true;
1207#include "PassRegistry.def"
1208
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001209 return callbacksAcceptPassName<CGSCCPassManager>(Name, Callbacks);
Chandler Carruth572e3402014-04-21 11:12:00 +00001210}
1211
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001212template <typename CallbacksT>
1213static bool isFunctionPassName(StringRef Name, CallbacksT &Callbacks) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001214 // Explicitly handle pass manager names.
1215 if (Name == "function")
1216 return true;
1217 if (Name == "loop")
1218 return true;
1219
Chandler Carruth241bf242016-08-03 07:44:48 +00001220 // Explicitly handle custom-parsed pass names.
1221 if (parseRepeatPassName(Name))
1222 return true;
1223
Chandler Carruth74a8a222016-06-17 07:15:29 +00001224#define FUNCTION_PASS(NAME, CREATE_PASS) \
1225 if (Name == NAME) \
1226 return true;
Chandler Carruth628503e2015-01-06 02:10:51 +00001227#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001228 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
Chandler Carruth628503e2015-01-06 02:10:51 +00001229 return true;
1230#include "PassRegistry.def"
1231
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001232 return callbacksAcceptPassName<FunctionPassManager>(Name, Callbacks);
Chandler Carruthd8330982014-01-12 09:34:22 +00001233}
1234
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001235template <typename CallbacksT>
1236static bool isLoopPassName(StringRef Name, CallbacksT &Callbacks) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001237 // Explicitly handle pass manager names.
1238 if (Name == "loop")
1239 return true;
1240
Chandler Carruth241bf242016-08-03 07:44:48 +00001241 // Explicitly handle custom-parsed pass names.
1242 if (parseRepeatPassName(Name))
1243 return true;
1244
Chandler Carruth74a8a222016-06-17 07:15:29 +00001245#define LOOP_PASS(NAME, CREATE_PASS) \
1246 if (Name == NAME) \
1247 return true;
Justin Bognereecc3c82016-02-25 07:23:08 +00001248#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
1249 if (Name == "require<" NAME ">" || Name == "invalidate<" NAME ">") \
1250 return true;
1251#include "PassRegistry.def"
1252
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001253 return callbacksAcceptPassName<LoopPassManager>(Name, Callbacks);
Justin Bognereecc3c82016-02-25 07:23:08 +00001254}
1255
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001256Optional<std::vector<PassBuilder::PipelineElement>>
1257PassBuilder::parsePipelineText(StringRef Text) {
1258 std::vector<PipelineElement> ResultPipeline;
1259
1260 SmallVector<std::vector<PipelineElement> *, 4> PipelineStack = {
1261 &ResultPipeline};
1262 for (;;) {
1263 std::vector<PipelineElement> &Pipeline = *PipelineStack.back();
1264 size_t Pos = Text.find_first_of(",()");
1265 Pipeline.push_back({Text.substr(0, Pos), {}});
1266
1267 // If we have a single terminating name, we're done.
1268 if (Pos == Text.npos)
1269 break;
1270
1271 char Sep = Text[Pos];
1272 Text = Text.substr(Pos + 1);
1273 if (Sep == ',')
1274 // Just a name ending in a comma, continue.
1275 continue;
1276
1277 if (Sep == '(') {
1278 // Push the inner pipeline onto the stack to continue processing.
1279 PipelineStack.push_back(&Pipeline.back().InnerPipeline);
1280 continue;
1281 }
1282
1283 assert(Sep == ')' && "Bogus separator!");
1284 // When handling the close parenthesis, we greedily consume them to avoid
1285 // empty strings in the pipeline.
1286 do {
1287 // If we try to pop the outer pipeline we have unbalanced parentheses.
1288 if (PipelineStack.size() == 1)
1289 return None;
1290
1291 PipelineStack.pop_back();
1292 } while (Text.consume_front(")"));
1293
1294 // Check if we've finished parsing.
1295 if (Text.empty())
1296 break;
1297
1298 // Otherwise, the end of an inner pipeline always has to be followed by
1299 // a comma, and then we can continue.
1300 if (!Text.consume_front(","))
1301 return None;
1302 }
1303
1304 if (PipelineStack.size() > 1)
1305 // Unbalanced paretheses.
1306 return None;
1307
1308 assert(PipelineStack.back() == &ResultPipeline &&
1309 "Wrong pipeline at the bottom of the stack!");
1310 return {std::move(ResultPipeline)};
1311}
1312
1313bool PassBuilder::parseModulePass(ModulePassManager &MPM,
1314 const PipelineElement &E, bool VerifyEachPass,
1315 bool DebugLogging) {
1316 auto &Name = E.Name;
1317 auto &InnerPipeline = E.InnerPipeline;
1318
1319 // First handle complex passes like the pass managers which carry pipelines.
1320 if (!InnerPipeline.empty()) {
1321 if (Name == "module") {
1322 ModulePassManager NestedMPM(DebugLogging);
1323 if (!parseModulePassPipeline(NestedMPM, InnerPipeline, VerifyEachPass,
1324 DebugLogging))
1325 return false;
1326 MPM.addPass(std::move(NestedMPM));
1327 return true;
1328 }
1329 if (Name == "cgscc") {
1330 CGSCCPassManager CGPM(DebugLogging);
1331 if (!parseCGSCCPassPipeline(CGPM, InnerPipeline, VerifyEachPass,
1332 DebugLogging))
1333 return false;
Chandler Carruth19913b22017-08-11 05:47:13 +00001334 MPM.addPass(createModuleToPostOrderCGSCCPassAdaptor(std::move(CGPM)));
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001335 return true;
1336 }
1337 if (Name == "function") {
1338 FunctionPassManager FPM(DebugLogging);
1339 if (!parseFunctionPassPipeline(FPM, InnerPipeline, VerifyEachPass,
1340 DebugLogging))
1341 return false;
1342 MPM.addPass(createModuleToFunctionPassAdaptor(std::move(FPM)));
1343 return true;
1344 }
Chandler Carruth241bf242016-08-03 07:44:48 +00001345 if (auto Count = parseRepeatPassName(Name)) {
1346 ModulePassManager NestedMPM(DebugLogging);
1347 if (!parseModulePassPipeline(NestedMPM, InnerPipeline, VerifyEachPass,
1348 DebugLogging))
1349 return false;
Chandler Carrutha053a882016-08-04 03:52:53 +00001350 MPM.addPass(createRepeatedPass(*Count, std::move(NestedMPM)));
Chandler Carruth241bf242016-08-03 07:44:48 +00001351 return true;
1352 }
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001353
1354 for (auto &C : ModulePipelineParsingCallbacks)
1355 if (C(Name, MPM, InnerPipeline))
1356 return true;
1357
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001358 // Normal passes can't have pipelines.
1359 return false;
1360 }
1361
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001362 // Manually handle aliases for pre-configured pipeline fragments.
Chandler Carruth8b3be4e2017-06-01 11:39:39 +00001363 if (startsWithDefaultPipelineAliasPrefix(Name)) {
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001364 SmallVector<StringRef, 3> Matches;
1365 if (!DefaultAliasRegex.match(Name, &Matches))
1366 return false;
1367 assert(Matches.size() == 3 && "Must capture two matched strings!");
1368
Jordan Rosef85a95f2016-07-25 18:34:51 +00001369 OptimizationLevel L = StringSwitch<OptimizationLevel>(Matches[2])
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001370 .Case("O0", O0)
1371 .Case("O1", O1)
1372 .Case("O2", O2)
1373 .Case("O3", O3)
1374 .Case("Os", Os)
1375 .Case("Oz", Oz);
Chandler Carruthe3f50642016-12-22 06:59:15 +00001376 if (L == O0)
1377 // At O0 we do nothing at all!
1378 return true;
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001379
1380 if (Matches[1] == "default") {
Chandler Carruthe3f50642016-12-22 06:59:15 +00001381 MPM.addPass(buildPerModuleDefaultPipeline(L, DebugLogging));
Chandler Carruth8b3be4e2017-06-01 11:39:39 +00001382 } else if (Matches[1] == "thinlto-pre-link") {
1383 MPM.addPass(buildThinLTOPreLinkDefaultPipeline(L, DebugLogging));
1384 } else if (Matches[1] == "thinlto") {
1385 MPM.addPass(buildThinLTODefaultPipeline(L, DebugLogging));
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001386 } else if (Matches[1] == "lto-pre-link") {
Chandler Carruthe3f50642016-12-22 06:59:15 +00001387 MPM.addPass(buildLTOPreLinkDefaultPipeline(L, DebugLogging));
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001388 } else {
1389 assert(Matches[1] == "lto" && "Not one of the matched options!");
Chandler Carruthe3f50642016-12-22 06:59:15 +00001390 MPM.addPass(buildLTODefaultPipeline(L, DebugLogging));
Chandler Carruth8b5a74192016-02-28 22:16:03 +00001391 }
1392 return true;
1393 }
1394
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001395 // Finally expand the basic registered passes from the .inc file.
Chandler Carruth58944182014-04-21 08:08:50 +00001396#define MODULE_PASS(NAME, CREATE_PASS) \
1397 if (Name == NAME) { \
1398 MPM.addPass(CREATE_PASS); \
1399 return true; \
Chandler Carruth52eef882014-01-12 12:15:39 +00001400 }
Chandler Carruth628503e2015-01-06 02:10:51 +00001401#define MODULE_ANALYSIS(NAME, CREATE_PASS) \
1402 if (Name == "require<" NAME ">") { \
Chandler Carruth9b35e6d2016-08-19 18:36:06 +00001403 MPM.addPass( \
1404 RequireAnalysisPass< \
1405 std::remove_reference<decltype(CREATE_PASS)>::type, Module>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +00001406 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001407 } \
1408 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +00001409 MPM.addPass(InvalidateAnalysisPass< \
1410 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001411 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +00001412 }
1413#include "PassRegistry.def"
1414
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001415 for (auto &C : ModulePipelineParsingCallbacks)
1416 if (C(Name, MPM, InnerPipeline))
1417 return true;
Chandler Carruth66445382014-01-11 08:16:35 +00001418 return false;
1419}
1420
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001421bool PassBuilder::parseCGSCCPass(CGSCCPassManager &CGPM,
1422 const PipelineElement &E, bool VerifyEachPass,
1423 bool DebugLogging) {
1424 auto &Name = E.Name;
1425 auto &InnerPipeline = E.InnerPipeline;
1426
1427 // First handle complex passes like the pass managers which carry pipelines.
1428 if (!InnerPipeline.empty()) {
1429 if (Name == "cgscc") {
1430 CGSCCPassManager NestedCGPM(DebugLogging);
1431 if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
1432 DebugLogging))
1433 return false;
1434 // Add the nested pass manager with the appropriate adaptor.
1435 CGPM.addPass(std::move(NestedCGPM));
1436 return true;
1437 }
1438 if (Name == "function") {
1439 FunctionPassManager FPM(DebugLogging);
1440 if (!parseFunctionPassPipeline(FPM, InnerPipeline, VerifyEachPass,
1441 DebugLogging))
1442 return false;
1443 // Add the nested pass manager with the appropriate adaptor.
Chandler Carruth19913b22017-08-11 05:47:13 +00001444 CGPM.addPass(createCGSCCToFunctionPassAdaptor(std::move(FPM)));
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001445 return true;
1446 }
Chandler Carruth241bf242016-08-03 07:44:48 +00001447 if (auto Count = parseRepeatPassName(Name)) {
1448 CGSCCPassManager NestedCGPM(DebugLogging);
1449 if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
1450 DebugLogging))
1451 return false;
Chandler Carrutha053a882016-08-04 03:52:53 +00001452 CGPM.addPass(createRepeatedPass(*Count, std::move(NestedCGPM)));
Chandler Carruth241bf242016-08-03 07:44:48 +00001453 return true;
1454 }
Chandler Carruth05ca5ac2016-12-28 11:07:33 +00001455 if (auto MaxRepetitions = parseDevirtPassName(Name)) {
1456 CGSCCPassManager NestedCGPM(DebugLogging);
1457 if (!parseCGSCCPassPipeline(NestedCGPM, InnerPipeline, VerifyEachPass,
1458 DebugLogging))
1459 return false;
Chandler Carruth19913b22017-08-11 05:47:13 +00001460 CGPM.addPass(
1461 createDevirtSCCRepeatedPass(std::move(NestedCGPM), *MaxRepetitions));
Chandler Carruth05ca5ac2016-12-28 11:07:33 +00001462 return true;
1463 }
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001464
1465 for (auto &C : CGSCCPipelineParsingCallbacks)
1466 if (C(Name, CGPM, InnerPipeline))
1467 return true;
1468
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001469 // Normal passes can't have pipelines.
1470 return false;
1471 }
1472
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001473// Now expand the basic registered passes from the .inc file.
Chandler Carruth572e3402014-04-21 11:12:00 +00001474#define CGSCC_PASS(NAME, CREATE_PASS) \
1475 if (Name == NAME) { \
1476 CGPM.addPass(CREATE_PASS); \
1477 return true; \
1478 }
Chandler Carruth628503e2015-01-06 02:10:51 +00001479#define CGSCC_ANALYSIS(NAME, CREATE_PASS) \
1480 if (Name == "require<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +00001481 CGPM.addPass(RequireAnalysisPass< \
Chandler Carruth9b35e6d2016-08-19 18:36:06 +00001482 std::remove_reference<decltype(CREATE_PASS)>::type, \
Chandler Carruth88823462016-08-24 09:37:14 +00001483 LazyCallGraph::SCC, CGSCCAnalysisManager, LazyCallGraph &, \
1484 CGSCCUpdateResult &>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +00001485 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001486 } \
1487 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +00001488 CGPM.addPass(InvalidateAnalysisPass< \
1489 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001490 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +00001491 }
1492#include "PassRegistry.def"
1493
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001494 for (auto &C : CGSCCPipelineParsingCallbacks)
1495 if (C(Name, CGPM, InnerPipeline))
1496 return true;
Chandler Carruth572e3402014-04-21 11:12:00 +00001497 return false;
1498}
1499
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001500bool PassBuilder::parseFunctionPass(FunctionPassManager &FPM,
1501 const PipelineElement &E,
1502 bool VerifyEachPass, bool DebugLogging) {
1503 auto &Name = E.Name;
1504 auto &InnerPipeline = E.InnerPipeline;
1505
1506 // First handle complex passes like the pass managers which carry pipelines.
1507 if (!InnerPipeline.empty()) {
1508 if (Name == "function") {
1509 FunctionPassManager NestedFPM(DebugLogging);
1510 if (!parseFunctionPassPipeline(NestedFPM, InnerPipeline, VerifyEachPass,
1511 DebugLogging))
1512 return false;
1513 // Add the nested pass manager with the appropriate adaptor.
1514 FPM.addPass(std::move(NestedFPM));
1515 return true;
1516 }
1517 if (Name == "loop") {
1518 LoopPassManager LPM(DebugLogging);
1519 if (!parseLoopPassPipeline(LPM, InnerPipeline, VerifyEachPass,
1520 DebugLogging))
1521 return false;
1522 // Add the nested pass manager with the appropriate adaptor.
1523 FPM.addPass(createFunctionToLoopPassAdaptor(std::move(LPM)));
1524 return true;
1525 }
Chandler Carruth241bf242016-08-03 07:44:48 +00001526 if (auto Count = parseRepeatPassName(Name)) {
1527 FunctionPassManager NestedFPM(DebugLogging);
1528 if (!parseFunctionPassPipeline(NestedFPM, InnerPipeline, VerifyEachPass,
1529 DebugLogging))
1530 return false;
Chandler Carrutha053a882016-08-04 03:52:53 +00001531 FPM.addPass(createRepeatedPass(*Count, std::move(NestedFPM)));
Chandler Carruth241bf242016-08-03 07:44:48 +00001532 return true;
1533 }
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001534
1535 for (auto &C : FunctionPipelineParsingCallbacks)
1536 if (C(Name, FPM, InnerPipeline))
1537 return true;
1538
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001539 // Normal passes can't have pipelines.
1540 return false;
1541 }
1542
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001543// Now expand the basic registered passes from the .inc file.
Chandler Carruth58944182014-04-21 08:08:50 +00001544#define FUNCTION_PASS(NAME, CREATE_PASS) \
1545 if (Name == NAME) { \
1546 FPM.addPass(CREATE_PASS); \
1547 return true; \
Chandler Carruth52eef882014-01-12 12:15:39 +00001548 }
Chandler Carruth628503e2015-01-06 02:10:51 +00001549#define FUNCTION_ANALYSIS(NAME, CREATE_PASS) \
1550 if (Name == "require<" NAME ">") { \
Chandler Carruth9b35e6d2016-08-19 18:36:06 +00001551 FPM.addPass( \
1552 RequireAnalysisPass< \
1553 std::remove_reference<decltype(CREATE_PASS)>::type, Function>()); \
Chandler Carruth628503e2015-01-06 02:10:51 +00001554 return true; \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001555 } \
1556 if (Name == "invalidate<" NAME ">") { \
Chandler Carruth470734b2016-02-26 12:30:18 +00001557 FPM.addPass(InvalidateAnalysisPass< \
1558 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Chandler Carruth3472ffb2015-01-06 04:49:44 +00001559 return true; \
Chandler Carruth628503e2015-01-06 02:10:51 +00001560 }
1561#include "PassRegistry.def"
1562
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001563 for (auto &C : FunctionPipelineParsingCallbacks)
1564 if (C(Name, FPM, InnerPipeline))
1565 return true;
Chandler Carruthd8330982014-01-12 09:34:22 +00001566 return false;
1567}
1568
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001569bool PassBuilder::parseLoopPass(LoopPassManager &LPM, const PipelineElement &E,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001570 bool VerifyEachPass, bool DebugLogging) {
Chandler Carruth241bf242016-08-03 07:44:48 +00001571 StringRef Name = E.Name;
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001572 auto &InnerPipeline = E.InnerPipeline;
1573
1574 // First handle complex passes like the pass managers which carry pipelines.
1575 if (!InnerPipeline.empty()) {
1576 if (Name == "loop") {
1577 LoopPassManager NestedLPM(DebugLogging);
1578 if (!parseLoopPassPipeline(NestedLPM, InnerPipeline, VerifyEachPass,
1579 DebugLogging))
1580 return false;
1581 // Add the nested pass manager with the appropriate adaptor.
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001582 LPM.addPass(std::move(NestedLPM));
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001583 return true;
1584 }
Chandler Carruth241bf242016-08-03 07:44:48 +00001585 if (auto Count = parseRepeatPassName(Name)) {
1586 LoopPassManager NestedLPM(DebugLogging);
1587 if (!parseLoopPassPipeline(NestedLPM, InnerPipeline, VerifyEachPass,
1588 DebugLogging))
1589 return false;
Chandler Carrutha053a882016-08-04 03:52:53 +00001590 LPM.addPass(createRepeatedPass(*Count, std::move(NestedLPM)));
Chandler Carruth241bf242016-08-03 07:44:48 +00001591 return true;
1592 }
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001593
1594 for (auto &C : LoopPipelineParsingCallbacks)
1595 if (C(Name, LPM, InnerPipeline))
1596 return true;
1597
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001598 // Normal passes can't have pipelines.
1599 return false;
1600 }
1601
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001602// Now expand the basic registered passes from the .inc file.
Justin Bognereecc3c82016-02-25 07:23:08 +00001603#define LOOP_PASS(NAME, CREATE_PASS) \
1604 if (Name == NAME) { \
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001605 LPM.addPass(CREATE_PASS); \
Justin Bognereecc3c82016-02-25 07:23:08 +00001606 return true; \
1607 }
1608#define LOOP_ANALYSIS(NAME, CREATE_PASS) \
1609 if (Name == "require<" NAME ">") { \
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001610 LPM.addPass(RequireAnalysisPass< \
Chandler Carruth410eaeb2017-01-11 06:23:21 +00001611 std::remove_reference<decltype(CREATE_PASS)>::type, Loop, \
1612 LoopAnalysisManager, LoopStandardAnalysisResults &, \
1613 LPMUpdater &>()); \
Justin Bognereecc3c82016-02-25 07:23:08 +00001614 return true; \
1615 } \
1616 if (Name == "invalidate<" NAME ">") { \
Chandler Carruthfdc6ba12016-08-03 09:14:03 +00001617 LPM.addPass(InvalidateAnalysisPass< \
Chandler Carruth470734b2016-02-26 12:30:18 +00001618 std::remove_reference<decltype(CREATE_PASS)>::type>()); \
Justin Bognereecc3c82016-02-25 07:23:08 +00001619 return true; \
1620 }
1621#include "PassRegistry.def"
1622
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001623 for (auto &C : LoopPipelineParsingCallbacks)
1624 if (C(Name, LPM, InnerPipeline))
1625 return true;
Justin Bognereecc3c82016-02-25 07:23:08 +00001626 return false;
1627}
1628
Chandler Carruthedf59962016-02-18 09:45:17 +00001629bool PassBuilder::parseAAPassName(AAManager &AA, StringRef Name) {
Chandler Carruth45a9c202016-03-11 09:15:11 +00001630#define MODULE_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
1631 if (Name == NAME) { \
1632 AA.registerModuleAnalysis< \
1633 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
1634 return true; \
1635 }
Chandler Carruthedf59962016-02-18 09:45:17 +00001636#define FUNCTION_ALIAS_ANALYSIS(NAME, CREATE_PASS) \
1637 if (Name == NAME) { \
Chandler Carruth58dde8c2016-02-26 12:17:54 +00001638 AA.registerFunctionAnalysis< \
1639 std::remove_reference<decltype(CREATE_PASS)>::type>(); \
Chandler Carruthedf59962016-02-18 09:45:17 +00001640 return true; \
1641 }
1642#include "PassRegistry.def"
1643
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001644 for (auto &C : AAParsingCallbacks)
1645 if (C(Name, AA))
1646 return true;
Chandler Carruthedf59962016-02-18 09:45:17 +00001647 return false;
1648}
1649
Justin Bognereecc3c82016-02-25 07:23:08 +00001650bool PassBuilder::parseLoopPassPipeline(LoopPassManager &LPM,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001651 ArrayRef<PipelineElement> Pipeline,
Justin Bognereecc3c82016-02-25 07:23:08 +00001652 bool VerifyEachPass,
1653 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001654 for (const auto &Element : Pipeline) {
1655 if (!parseLoopPass(LPM, Element, VerifyEachPass, DebugLogging))
1656 return false;
1657 // FIXME: No verifier support for Loop passes!
Justin Bognereecc3c82016-02-25 07:23:08 +00001658 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001659 return true;
Justin Bognereecc3c82016-02-25 07:23:08 +00001660}
1661
Chandler Carruth1ff77242015-03-07 09:02:36 +00001662bool PassBuilder::parseFunctionPassPipeline(FunctionPassManager &FPM,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001663 ArrayRef<PipelineElement> Pipeline,
Chandler Carruth1ff77242015-03-07 09:02:36 +00001664 bool VerifyEachPass,
1665 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001666 for (const auto &Element : Pipeline) {
1667 if (!parseFunctionPass(FPM, Element, VerifyEachPass, DebugLogging))
1668 return false;
1669 if (VerifyEachPass)
1670 FPM.addPass(VerifierPass());
Chandler Carruthd8330982014-01-12 09:34:22 +00001671 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001672 return true;
Chandler Carruthd8330982014-01-12 09:34:22 +00001673}
1674
Chandler Carruth1ff77242015-03-07 09:02:36 +00001675bool PassBuilder::parseCGSCCPassPipeline(CGSCCPassManager &CGPM,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001676 ArrayRef<PipelineElement> Pipeline,
Chandler Carruth1ff77242015-03-07 09:02:36 +00001677 bool VerifyEachPass,
1678 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001679 for (const auto &Element : Pipeline) {
1680 if (!parseCGSCCPass(CGPM, Element, VerifyEachPass, DebugLogging))
1681 return false;
1682 // FIXME: No verifier support for CGSCC passes!
Chandler Carruth572e3402014-04-21 11:12:00 +00001683 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001684 return true;
Chandler Carruth572e3402014-04-21 11:12:00 +00001685}
1686
NAKAMURA Takumia42f5282016-05-16 10:13:37 +00001687void PassBuilder::crossRegisterProxies(LoopAnalysisManager &LAM,
1688 FunctionAnalysisManager &FAM,
1689 CGSCCAnalysisManager &CGAM,
1690 ModuleAnalysisManager &MAM) {
1691 MAM.registerPass([&] { return FunctionAnalysisManagerModuleProxy(FAM); });
1692 MAM.registerPass([&] { return CGSCCAnalysisManagerModuleProxy(CGAM); });
NAKAMURA Takumia42f5282016-05-16 10:13:37 +00001693 CGAM.registerPass([&] { return ModuleAnalysisManagerCGSCCProxy(MAM); });
1694 FAM.registerPass([&] { return CGSCCAnalysisManagerFunctionProxy(CGAM); });
1695 FAM.registerPass([&] { return ModuleAnalysisManagerFunctionProxy(MAM); });
1696 FAM.registerPass([&] { return LoopAnalysisManagerFunctionProxy(LAM); });
1697 LAM.registerPass([&] { return FunctionAnalysisManagerLoopProxy(FAM); });
1698}
1699
Chandler Carruth1ff77242015-03-07 09:02:36 +00001700bool PassBuilder::parseModulePassPipeline(ModulePassManager &MPM,
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001701 ArrayRef<PipelineElement> Pipeline,
Chandler Carruth1ff77242015-03-07 09:02:36 +00001702 bool VerifyEachPass,
1703 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001704 for (const auto &Element : Pipeline) {
1705 if (!parseModulePass(MPM, Element, VerifyEachPass, DebugLogging))
1706 return false;
1707 if (VerifyEachPass)
1708 MPM.addPass(VerifierPass());
Chandler Carruth66445382014-01-11 08:16:35 +00001709 }
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001710 return true;
Chandler Carruth66445382014-01-11 08:16:35 +00001711}
1712
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001713// Primary pass pipeline description parsing routine for a \c ModulePassManager
Chandler Carruth66445382014-01-11 08:16:35 +00001714// FIXME: Should this routine accept a TargetMachine or require the caller to
1715// pre-populate the analysis managers with target-specific stuff?
Chandler Carruth1ff77242015-03-07 09:02:36 +00001716bool PassBuilder::parsePassPipeline(ModulePassManager &MPM,
1717 StringRef PipelineText, bool VerifyEachPass,
1718 bool DebugLogging) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001719 auto Pipeline = parsePipelineText(PipelineText);
1720 if (!Pipeline || Pipeline->empty())
1721 return false;
Chandler Carruth66445382014-01-11 08:16:35 +00001722
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001723 // If the first name isn't at the module layer, wrap the pipeline up
1724 // automatically.
1725 StringRef FirstName = Pipeline->front().Name;
Chandler Carruth66445382014-01-11 08:16:35 +00001726
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001727 if (!isModulePassName(FirstName, ModulePipelineParsingCallbacks)) {
1728 if (isCGSCCPassName(FirstName, CGSCCPipelineParsingCallbacks)) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001729 Pipeline = {{"cgscc", std::move(*Pipeline)}};
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001730 } else if (isFunctionPassName(FirstName,
1731 FunctionPipelineParsingCallbacks)) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001732 Pipeline = {{"function", std::move(*Pipeline)}};
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001733 } else if (isLoopPassName(FirstName, LoopPipelineParsingCallbacks)) {
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001734 Pipeline = {{"function", {{"loop", std::move(*Pipeline)}}}};
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001735 } else {
1736 for (auto &C : TopLevelPipelineParsingCallbacks)
1737 if (C(MPM, *Pipeline, VerifyEachPass, DebugLogging))
1738 return true;
1739
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001740 // Unknown pass name!
Chandler Carruth572e3402014-04-21 11:12:00 +00001741 return false;
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001742 }
Chandler Carruth572e3402014-04-21 11:12:00 +00001743 }
1744
Chandler Carruth6cb2ab22016-08-03 03:21:41 +00001745 return parseModulePassPipeline(MPM, *Pipeline, VerifyEachPass, DebugLogging);
Chandler Carruth66445382014-01-11 08:16:35 +00001746}
Chandler Carruthedf59962016-02-18 09:45:17 +00001747
Philip Pfaffe730f2f92017-07-10 10:57:55 +00001748// Primary pass pipeline description parsing routine for a \c CGSCCPassManager
1749bool PassBuilder::parsePassPipeline(CGSCCPassManager &CGPM,
1750 StringRef PipelineText, bool VerifyEachPass,
1751 bool DebugLogging) {
1752 auto Pipeline = parsePipelineText(PipelineText);
1753 if (!Pipeline || Pipeline->empty())
1754 return false;
1755
1756 StringRef FirstName = Pipeline->front().Name;
1757 if (!isCGSCCPassName(FirstName, CGSCCPipelineParsingCallbacks))
1758 return false;
1759
1760 return parseCGSCCPassPipeline(CGPM, *Pipeline, VerifyEachPass, DebugLogging);
1761}
1762
1763// Primary pass pipeline description parsing routine for a \c
1764// FunctionPassManager
1765bool PassBuilder::parsePassPipeline(FunctionPassManager &FPM,
1766 StringRef PipelineText, bool VerifyEachPass,
1767 bool DebugLogging) {
1768 auto Pipeline = parsePipelineText(PipelineText);
1769 if (!Pipeline || Pipeline->empty())
1770 return false;
1771
1772 StringRef FirstName = Pipeline->front().Name;
1773 if (!isFunctionPassName(FirstName, FunctionPipelineParsingCallbacks))
1774 return false;
1775
1776 return parseFunctionPassPipeline(FPM, *Pipeline, VerifyEachPass,
1777 DebugLogging);
1778}
1779
1780// Primary pass pipeline description parsing routine for a \c LoopPassManager
1781bool PassBuilder::parsePassPipeline(LoopPassManager &CGPM,
1782 StringRef PipelineText, bool VerifyEachPass,
1783 bool DebugLogging) {
1784 auto Pipeline = parsePipelineText(PipelineText);
1785 if (!Pipeline || Pipeline->empty())
1786 return false;
1787
1788 return parseLoopPassPipeline(CGPM, *Pipeline, VerifyEachPass, DebugLogging);
1789}
1790
Chandler Carruthedf59962016-02-18 09:45:17 +00001791bool PassBuilder::parseAAPipeline(AAManager &AA, StringRef PipelineText) {
Chandler Carruth060ad612016-12-23 20:38:19 +00001792 // If the pipeline just consists of the word 'default' just replace the AA
1793 // manager with our default one.
1794 if (PipelineText == "default") {
1795 AA = buildDefaultAAPipeline();
1796 return true;
1797 }
1798
Chandler Carruthedf59962016-02-18 09:45:17 +00001799 while (!PipelineText.empty()) {
1800 StringRef Name;
1801 std::tie(Name, PipelineText) = PipelineText.split(',');
1802 if (!parseAAPassName(AA, Name))
1803 return false;
1804 }
1805
1806 return true;
1807}