PassManagerBuilder.cpp revision fe16848601bdde6e3a5e0860199169dd171222a4
1//===- PassManagerBuilder.cpp - Build Standard Pass -----------------------===// 2// 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// 10// This file defines the PassManagerBuilder class, which is used to set up a 11// "standard" optimization sequence suitable for languages like C and C++. 12// 13//===----------------------------------------------------------------------===// 14 15 16#include "llvm/Transforms/IPO/PassManagerBuilder.h" 17#include "llvm-c/Transforms/PassManagerBuilder.h" 18#include "llvm/ADT/SmallVector.h" 19#include "llvm/Analysis/Passes.h" 20#include "llvm/Analysis/Verifier.h" 21#include "llvm/PassManager.h" 22#include "llvm/Support/CommandLine.h" 23#include "llvm/Support/ManagedStatic.h" 24#include "llvm/Target/TargetLibraryInfo.h" 25#include "llvm/Transforms/IPO.h" 26#include "llvm/Transforms/Scalar.h" 27#include "llvm/Transforms/Vectorize.h" 28 29using namespace llvm; 30 31static cl::opt<bool> 32RunLoopVectorization("vectorize-loops", cl::Hidden, 33 cl::desc("Run the Loop vectorization passes")); 34 35static cl::opt<bool> 36LateVectorization("late-vectorize", cl::init(true), cl::Hidden, 37 cl::desc("Run the vectorization pasess late in the pass " 38 "pipeline (after the inliner)")); 39 40static cl::opt<bool> 41RunSLPVectorization("vectorize-slp", cl::Hidden, 42 cl::desc("Run the SLP vectorization passes")); 43 44static cl::opt<bool> 45RunBBVectorization("vectorize-slp-aggressive", cl::Hidden, 46 cl::desc("Run the BB vectorization passes")); 47 48static cl::opt<bool> 49UseGVNAfterVectorization("use-gvn-after-vectorization", 50 cl::init(false), cl::Hidden, 51 cl::desc("Run GVN instead of Early CSE after vectorization passes")); 52 53static cl::opt<bool> UseNewSROA("use-new-sroa", 54 cl::init(true), cl::Hidden, 55 cl::desc("Enable the new, experimental SROA pass")); 56 57PassManagerBuilder::PassManagerBuilder() { 58 OptLevel = 2; 59 SizeLevel = 0; 60 LibraryInfo = 0; 61 Inliner = 0; 62 DisableUnitAtATime = false; 63 DisableUnrollLoops = false; 64 BBVectorize = RunBBVectorization; 65 SLPVectorize = RunSLPVectorization; 66 LoopVectorize = RunLoopVectorization; 67 LateVectorize = LateVectorization; 68} 69 70PassManagerBuilder::~PassManagerBuilder() { 71 delete LibraryInfo; 72 delete Inliner; 73} 74 75/// Set of global extensions, automatically added as part of the standard set. 76static ManagedStatic<SmallVector<std::pair<PassManagerBuilder::ExtensionPointTy, 77 PassManagerBuilder::ExtensionFn>, 8> > GlobalExtensions; 78 79void PassManagerBuilder::addGlobalExtension( 80 PassManagerBuilder::ExtensionPointTy Ty, 81 PassManagerBuilder::ExtensionFn Fn) { 82 GlobalExtensions->push_back(std::make_pair(Ty, Fn)); 83} 84 85void PassManagerBuilder::addExtension(ExtensionPointTy Ty, ExtensionFn Fn) { 86 Extensions.push_back(std::make_pair(Ty, Fn)); 87} 88 89void PassManagerBuilder::addExtensionsToPM(ExtensionPointTy ETy, 90 PassManagerBase &PM) const { 91 for (unsigned i = 0, e = GlobalExtensions->size(); i != e; ++i) 92 if ((*GlobalExtensions)[i].first == ETy) 93 (*GlobalExtensions)[i].second(*this, PM); 94 for (unsigned i = 0, e = Extensions.size(); i != e; ++i) 95 if (Extensions[i].first == ETy) 96 Extensions[i].second(*this, PM); 97} 98 99void 100PassManagerBuilder::addInitialAliasAnalysisPasses(PassManagerBase &PM) const { 101 // Add TypeBasedAliasAnalysis before BasicAliasAnalysis so that 102 // BasicAliasAnalysis wins if they disagree. This is intended to help 103 // support "obvious" type-punning idioms. 104 PM.add(createTypeBasedAliasAnalysisPass()); 105 PM.add(createBasicAliasAnalysisPass()); 106} 107 108void PassManagerBuilder::populateFunctionPassManager(FunctionPassManager &FPM) { 109 addExtensionsToPM(EP_EarlyAsPossible, FPM); 110 111 // Add LibraryInfo if we have some. 112 if (LibraryInfo) FPM.add(new TargetLibraryInfo(*LibraryInfo)); 113 114 if (OptLevel == 0) return; 115 116 addInitialAliasAnalysisPasses(FPM); 117 118 FPM.add(createCFGSimplificationPass()); 119 if (UseNewSROA) 120 FPM.add(createSROAPass()); 121 else 122 FPM.add(createScalarReplAggregatesPass()); 123 FPM.add(createEarlyCSEPass()); 124 FPM.add(createLowerExpectIntrinsicPass()); 125} 126 127void PassManagerBuilder::populateModulePassManager(PassManagerBase &MPM) { 128 // If all optimizations are disabled, just run the always-inline pass. 129 if (OptLevel == 0) { 130 if (Inliner) { 131 MPM.add(Inliner); 132 Inliner = 0; 133 } 134 135 // FIXME: This is a HACK! The inliner pass above implicitly creates a CGSCC 136 // pass manager, but we don't want to add extensions into that pass manager. 137 // To prevent this we must insert a no-op module pass to reset the pass 138 // manager to get the same behavior as EP_OptimizerLast in non-O0 builds. 139 if (!GlobalExtensions->empty() || !Extensions.empty()) 140 MPM.add(createBarrierNoopPass()); 141 142 addExtensionsToPM(EP_EnabledOnOptLevel0, MPM); 143 return; 144 } 145 146 // Add LibraryInfo if we have some. 147 if (LibraryInfo) MPM.add(new TargetLibraryInfo(*LibraryInfo)); 148 149 addInitialAliasAnalysisPasses(MPM); 150 151 if (!DisableUnitAtATime) { 152 addExtensionsToPM(EP_ModuleOptimizerEarly, MPM); 153 154 MPM.add(createGlobalOptimizerPass()); // Optimize out global vars 155 156 MPM.add(createIPSCCPPass()); // IP SCCP 157 MPM.add(createDeadArgEliminationPass()); // Dead argument elimination 158 159 MPM.add(createInstructionCombiningPass());// Clean up after IPCP & DAE 160 MPM.add(createCFGSimplificationPass()); // Clean up after IPCP & DAE 161 } 162 163 // Start of CallGraph SCC passes. 164 if (!DisableUnitAtATime) 165 MPM.add(createPruneEHPass()); // Remove dead EH info 166 if (Inliner) { 167 MPM.add(Inliner); 168 Inliner = 0; 169 } 170 if (!DisableUnitAtATime) 171 MPM.add(createFunctionAttrsPass()); // Set readonly/readnone attrs 172 if (OptLevel > 2) 173 MPM.add(createArgumentPromotionPass()); // Scalarize uninlined fn args 174 175 // Start of function pass. 176 // Break up aggregate allocas, using SSAUpdater. 177 if (UseNewSROA) 178 MPM.add(createSROAPass(/*RequiresDomTree*/ false)); 179 else 180 MPM.add(createScalarReplAggregatesPass(-1, false)); 181 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies 182 MPM.add(createJumpThreadingPass()); // Thread jumps. 183 MPM.add(createCorrelatedValuePropagationPass()); // Propagate conditionals 184 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs 185 MPM.add(createInstructionCombiningPass()); // Combine silly seq's 186 187 MPM.add(createTailCallEliminationPass()); // Eliminate tail calls 188 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs 189 MPM.add(createReassociatePass()); // Reassociate expressions 190 MPM.add(createLoopRotatePass()); // Rotate Loop 191 MPM.add(createLICMPass()); // Hoist loop invariants 192 MPM.add(createLoopUnswitchPass(SizeLevel || OptLevel < 3)); 193 MPM.add(createInstructionCombiningPass()); 194 MPM.add(createIndVarSimplifyPass()); // Canonicalize indvars 195 MPM.add(createLoopIdiomPass()); // Recognize idioms like memset. 196 MPM.add(createLoopDeletionPass()); // Delete dead loops 197 198 if (!LateVectorize && LoopVectorize) 199 MPM.add(createLoopVectorizePass(DisableUnrollLoops)); 200 201 if (!DisableUnrollLoops) 202 MPM.add(createLoopUnrollPass()); // Unroll small loops 203 addExtensionsToPM(EP_LoopOptimizerEnd, MPM); 204 205 if (OptLevel > 1) 206 MPM.add(createGVNPass()); // Remove redundancies 207 MPM.add(createMemCpyOptPass()); // Remove memcpy / form memset 208 MPM.add(createSCCPPass()); // Constant prop with SCCP 209 210 // Run instcombine after redundancy elimination to exploit opportunities 211 // opened up by them. 212 MPM.add(createInstructionCombiningPass()); 213 MPM.add(createJumpThreadingPass()); // Thread jumps 214 MPM.add(createCorrelatedValuePropagationPass()); 215 MPM.add(createDeadStoreEliminationPass()); // Delete dead stores 216 217 addExtensionsToPM(EP_ScalarOptimizerLate, MPM); 218 219 if (SLPVectorize) 220 MPM.add(createSLPVectorizerPass()); // Vectorize parallel scalar chains. 221 222 if (BBVectorize) { 223 MPM.add(createBBVectorizePass()); 224 MPM.add(createInstructionCombiningPass()); 225 if (OptLevel > 1 && UseGVNAfterVectorization) 226 MPM.add(createGVNPass()); // Remove redundancies 227 else 228 MPM.add(createEarlyCSEPass()); // Catch trivial redundancies 229 230 // BBVectorize may have significantly shortened a loop body; unroll again. 231 if (!DisableUnrollLoops) 232 MPM.add(createLoopUnrollPass()); 233 } 234 235 MPM.add(createAggressiveDCEPass()); // Delete dead instructions 236 MPM.add(createCFGSimplificationPass()); // Merge & remove BBs 237 MPM.add(createInstructionCombiningPass()); // Clean up after everything. 238 239 // As an experimental mode, run any vectorization passes in a separate 240 // pipeline from the CGSCC pass manager that runs iteratively with the 241 // inliner. 242 if (LateVectorize && LoopVectorize) { 243 // FIXME: This is a HACK! The inliner pass above implicitly creates a CGSCC 244 // pass manager that we are specifically trying to avoid. To prevent this 245 // we must insert a no-op module pass to reset the pass manager. 246 MPM.add(createBarrierNoopPass()); 247 248 // Add the various vectorization passes and relevant cleanup passes for 249 // them since we are no longer in the middle of the main scalar pipeline. 250 MPM.add(createLoopVectorizePass(DisableUnrollLoops)); 251 MPM.add(createInstructionCombiningPass()); 252 MPM.add(createCFGSimplificationPass()); 253 } 254 255 if (!DisableUnitAtATime) { 256 // FIXME: We shouldn't bother with this anymore. 257 MPM.add(createStripDeadPrototypesPass()); // Get rid of dead prototypes 258 259 // GlobalOpt already deletes dead functions and globals, at -O2 try a 260 // late pass of GlobalDCE. It is capable of deleting dead cycles. 261 if (OptLevel > 1) { 262 MPM.add(createGlobalDCEPass()); // Remove dead fns and globals. 263 MPM.add(createConstantMergePass()); // Merge dup global constants 264 } 265 } 266 addExtensionsToPM(EP_OptimizerLast, MPM); 267} 268 269void PassManagerBuilder::populateLTOPassManager(PassManagerBase &PM, 270 bool Internalize, 271 bool RunInliner, 272 bool DisableGVNLoadPRE) { 273 // Provide AliasAnalysis services for optimizations. 274 addInitialAliasAnalysisPasses(PM); 275 276 // Now that composite has been compiled, scan through the module, looking 277 // for a main function. If main is defined, mark all other functions 278 // internal. 279 if (Internalize) 280 PM.add(createInternalizePass("main", None)); 281 282 // Propagate constants at call sites into the functions they call. This 283 // opens opportunities for globalopt (and inlining) by substituting function 284 // pointers passed as arguments to direct uses of functions. 285 PM.add(createIPSCCPPass()); 286 287 // Now that we internalized some globals, see if we can hack on them! 288 PM.add(createGlobalOptimizerPass()); 289 290 // Linking modules together can lead to duplicated global constants, only 291 // keep one copy of each constant. 292 PM.add(createConstantMergePass()); 293 294 // Remove unused arguments from functions. 295 PM.add(createDeadArgEliminationPass()); 296 297 // Reduce the code after globalopt and ipsccp. Both can open up significant 298 // simplification opportunities, and both can propagate functions through 299 // function pointers. When this happens, we often have to resolve varargs 300 // calls, etc, so let instcombine do this. 301 PM.add(createInstructionCombiningPass()); 302 303 // Inline small functions 304 if (RunInliner) 305 PM.add(createFunctionInliningPass()); 306 307 PM.add(createPruneEHPass()); // Remove dead EH info. 308 309 // Optimize globals again if we ran the inliner. 310 if (RunInliner) 311 PM.add(createGlobalOptimizerPass()); 312 PM.add(createGlobalDCEPass()); // Remove dead functions. 313 314 // If we didn't decide to inline a function, check to see if we can 315 // transform it to pass arguments by value instead of by reference. 316 PM.add(createArgumentPromotionPass()); 317 318 // The IPO passes may leave cruft around. Clean up after them. 319 PM.add(createInstructionCombiningPass()); 320 PM.add(createJumpThreadingPass()); 321 322 // Break up allocas 323 if (UseNewSROA) 324 PM.add(createSROAPass()); 325 else 326 PM.add(createScalarReplAggregatesPass()); 327 328 // Run a few AA driven optimizations here and now, to cleanup the code. 329 PM.add(createFunctionAttrsPass()); // Add nocapture. 330 PM.add(createGlobalsModRefPass()); // IP alias analysis. 331 332 PM.add(createLICMPass()); // Hoist loop invariants. 333 PM.add(createGVNPass(DisableGVNLoadPRE)); // Remove redundancies. 334 PM.add(createMemCpyOptPass()); // Remove dead memcpys. 335 336 // Nuke dead stores. 337 PM.add(createDeadStoreEliminationPass()); 338 339 // Cleanup and simplify the code after the scalar optimizations. 340 PM.add(createInstructionCombiningPass()); 341 342 PM.add(createJumpThreadingPass()); 343 344 // Delete basic blocks, which optimization passes may have killed. 345 PM.add(createCFGSimplificationPass()); 346 347 // Now that we have optimized the program, discard unreachable functions. 348 PM.add(createGlobalDCEPass()); 349} 350 351inline PassManagerBuilder *unwrap(LLVMPassManagerBuilderRef P) { 352 return reinterpret_cast<PassManagerBuilder*>(P); 353} 354 355inline LLVMPassManagerBuilderRef wrap(PassManagerBuilder *P) { 356 return reinterpret_cast<LLVMPassManagerBuilderRef>(P); 357} 358 359LLVMPassManagerBuilderRef LLVMPassManagerBuilderCreate() { 360 PassManagerBuilder *PMB = new PassManagerBuilder(); 361 return wrap(PMB); 362} 363 364void LLVMPassManagerBuilderDispose(LLVMPassManagerBuilderRef PMB) { 365 PassManagerBuilder *Builder = unwrap(PMB); 366 delete Builder; 367} 368 369void 370LLVMPassManagerBuilderSetOptLevel(LLVMPassManagerBuilderRef PMB, 371 unsigned OptLevel) { 372 PassManagerBuilder *Builder = unwrap(PMB); 373 Builder->OptLevel = OptLevel; 374} 375 376void 377LLVMPassManagerBuilderSetSizeLevel(LLVMPassManagerBuilderRef PMB, 378 unsigned SizeLevel) { 379 PassManagerBuilder *Builder = unwrap(PMB); 380 Builder->SizeLevel = SizeLevel; 381} 382 383void 384LLVMPassManagerBuilderSetDisableUnitAtATime(LLVMPassManagerBuilderRef PMB, 385 LLVMBool Value) { 386 PassManagerBuilder *Builder = unwrap(PMB); 387 Builder->DisableUnitAtATime = Value; 388} 389 390void 391LLVMPassManagerBuilderSetDisableUnrollLoops(LLVMPassManagerBuilderRef PMB, 392 LLVMBool Value) { 393 PassManagerBuilder *Builder = unwrap(PMB); 394 Builder->DisableUnrollLoops = Value; 395} 396 397void 398LLVMPassManagerBuilderSetDisableSimplifyLibCalls(LLVMPassManagerBuilderRef PMB, 399 LLVMBool Value) { 400 // NOTE: The simplify-libcalls pass has been removed. 401} 402 403void 404LLVMPassManagerBuilderUseInlinerWithThreshold(LLVMPassManagerBuilderRef PMB, 405 unsigned Threshold) { 406 PassManagerBuilder *Builder = unwrap(PMB); 407 Builder->Inliner = createFunctionInliningPass(Threshold); 408} 409 410void 411LLVMPassManagerBuilderPopulateFunctionPassManager(LLVMPassManagerBuilderRef PMB, 412 LLVMPassManagerRef PM) { 413 PassManagerBuilder *Builder = unwrap(PMB); 414 FunctionPassManager *FPM = unwrap<FunctionPassManager>(PM); 415 Builder->populateFunctionPassManager(*FPM); 416} 417 418void 419LLVMPassManagerBuilderPopulateModulePassManager(LLVMPassManagerBuilderRef PMB, 420 LLVMPassManagerRef PM) { 421 PassManagerBuilder *Builder = unwrap(PMB); 422 PassManagerBase *MPM = unwrap(PM); 423 Builder->populateModulePassManager(*MPM); 424} 425 426void LLVMPassManagerBuilderPopulateLTOPassManager(LLVMPassManagerBuilderRef PMB, 427 LLVMPassManagerRef PM, 428 LLVMBool Internalize, 429 LLVMBool RunInliner) { 430 PassManagerBuilder *Builder = unwrap(PMB); 431 PassManagerBase *LPM = unwrap(PM); 432 Builder->populateLTOPassManager(*LPM, Internalize != 0, RunInliner != 0); 433} 434