include/llvm/Support/StandardPasses.h

   1 //===-- llvm/Support/StandardPasses.h - Standard pass lists -----*- C++ -*-===//
   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 utility functions for creating a "standard" set of
  11 // optimization passes, so that compilers and tools which use optimization
  12 // passes use the same set of standard passes.
  13 //
  14 // These are implemented as inline functions so that we do not have to worry
  15 // about link issues.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #ifndef LLVM_SUPPORT_STANDARDPASSES_H
  20 #define LLVM_SUPPORT_STANDARDPASSES_H
  21
  22 #include "llvm/PassManager.h"
  23 #include "llvm/Analysis/Dominators.h"
  24 #include "llvm/Analysis/Passes.h"
  25 #include "llvm/Analysis/Verifier.h"
  26 #include "llvm/Transforms/Scalar.h"
  27 #include "llvm/Transforms/IPO.h"
  28
  29 namespace llvm {
  30   /// createStandardFunctionPasses - Add the standard list of function passes to
  31   /// the provided pass manager.
  32   ///
  33   /// \arg OptimizationLevel - The optimization level, corresponding to -O0,
  34   /// -O1, etc.
  35   static inline void createStandardFunctionPasses(PassManagerBase *PM,
  36                                                   unsigned OptimizationLevel);
  37
  38   /// createStandardModulePasses - Add the standard list of module passes to the
  39   /// provided pass manager.
  40   ///
  41   /// \arg OptimizationLevel - The optimization level, corresponding to -O0,
  42   /// -O1, etc.
  43   /// \arg OptimizeSize - Whether the transformations should optimize for size.
  44   /// \arg UnitAtATime - Allow passes which may make global module changes.
  45   /// \arg UnrollLoops - Allow loop unrolling.
  46   /// \arg SimplifyLibCalls - Allow library calls to be simplified.
  47   /// \arg HaveExceptions - Whether the module may have code using exceptions.
  48   /// \arg InliningPass - The inlining pass to use, if any, or null. This will
  49   /// always be added, even at -O0.a
  50   static inline void createStandardModulePasses(PassManagerBase *PM,
  51                                                 unsigned OptimizationLevel,
  52                                                 bool OptimizeSize,
  53                                                 bool UnitAtATime,
  54                                                 bool UnrollLoops,
  55                                                 bool SimplifyLibCalls,
  56                                                 bool HaveExceptions,
  57                                                 Pass *InliningPass);
  58
  59   /// createStandardLTOPasses - Add the standard list of module passes suitable
  60   /// for link time optimization.
  61   ///
  62   /// Internalize - Run the internalize pass.
  63   /// RunInliner - Use a function inlining pass.
  64   /// VerifyEach - Run the verifier after each pass.
  65   static inline void createStandardLTOPasses(PassManagerBase *PM,
  66                                              bool Internalize,
  67                                              bool RunInliner,
  68                                              bool VerifyEach);
  69
  70   // Implementations
  71
  72   static inline void createStandardAliasAnalysisPasses(PassManagerBase *PM) {
  73     // Add TypeBasedAliasAnalysis before BasicAliasAnalysis so that
  74     // BasicAliasAnalysis wins if they disagree. This is intended to help
  75     // support "obvious" type-punning idioms.
  76     PM->add(createTypeBasedAliasAnalysisPass());
  77     PM->add(createBasicAliasAnalysisPass());
  78   }
  79
  80   static inline void createStandardFunctionPasses(PassManagerBase *PM,
  81                                                   unsigned OptimizationLevel) {
  82     if (OptimizationLevel > 0) {
  83       createStandardAliasAnalysisPasses(PM);
  84       PM->add(createCFGSimplificationPass());
  85       PM->add(createScalarReplAggregatesPass());
  86       PM->add(createEarlyCSEPass());
  87     }
  88   }
  89
  90   /// createStandardModulePasses - Add the standard module passes.  This is
  91   /// expected to be run after the standard function passes.
  92   static inline void createStandardModulePasses(PassManagerBase *PM,
  93                                                 unsigned OptimizationLevel,
  94                                                 bool OptimizeSize,
  95                                                 bool UnitAtATime,
  96                                                 bool UnrollLoops,
  97                                                 bool OptimizeBuiltins,
  98                                                 bool HaveExceptions,
  99                                                 Pass *InliningPass) {
 100     createStandardAliasAnalysisPasses(PM);
 101
 102     if (OptimizationLevel == 0) {
 103       if (InliningPass)
 104         PM->add(InliningPass);
 105       return;
 106     }
 107
 108     if (UnitAtATime) {
 109       PM->add(createGlobalOptimizerPass());     // Optimize out global vars
 110
 111       PM->add(createIPSCCPPass());              // IP SCCP
 112       PM->add(createDeadArgEliminationPass());  // Dead argument elimination
 113     }
 114     PM->add(createInstructionCombiningPass());  // Clean up after IPCP & DAE
 115     PM->add(createCFGSimplificationPass());     // Clean up after IPCP & DAE
 116
 117     // Start of CallGraph SCC passes.
 118     if (UnitAtATime && HaveExceptions)
 119       PM->add(createPruneEHPass());           // Remove dead EH info
 120     if (InliningPass)
 121       PM->add(InliningPass);
 122     if (UnitAtATime)
 123       PM->add(createFunctionAttrsPass());       // Set readonly/readnone attrs
 124     if (OptimizationLevel > 2)
 125       PM->add(createArgumentPromotionPass());   // Scalarize uninlined fn args
 126
 127     // Start of function pass.
 128     PM->add(createScalarReplAggregatesPass());  // Break up aggregate allocas
 129     PM->add(createEarlyCSEPass());              // Catch trivial redundancies
 130     if (OptimizeBuiltins)
 131       PM->add(createSimplifyLibCallsPass());    // Library Call Optimizations
 132     PM->add(createJumpThreadingPass());         // Thread jumps.
 133     PM->add(createCorrelatedValuePropagationPass()); // Propagate conditionals
 134     PM->add(createCFGSimplificationPass());     // Merge & remove BBs
 135     PM->add(createInstructionCombiningPass());  // Combine silly seq's
 136
 137     PM->add(createTailCallEliminationPass());   // Eliminate tail calls
 138     PM->add(createCFGSimplificationPass());     // Merge & remove BBs
 139     PM->add(createReassociatePass());           // Reassociate expressions
 140     PM->add(createLoopRotatePass());            // Rotate Loop
 141     PM->add(createLICMPass());                  // Hoist loop invariants
 142     PM->add(createLoopUnswitchPass(OptimizeSize || OptimizationLevel < 3));
 143     PM->add(createInstructionCombiningPass());
 144     PM->add(createIndVarSimplifyPass());        // Canonicalize indvars
 145     if (OptimizeBuiltins)
 146       PM->add(createLoopIdiomPass());           // Recognize idioms like memset.
 147     PM->add(createLoopDeletionPass());          // Delete dead loops
 148     if (UnrollLoops)
 149       PM->add(createLoopUnrollPass());          // Unroll small loops
 150     PM->add(createInstructionCombiningPass());  // Clean up after the unroller
 151     if (OptimizationLevel > 1)
 152       PM->add(createGVNPass());                 // Remove redundancies
 153     PM->add(createMemCpyOptPass());             // Remove memcpy / form memset
 154     PM->add(createSCCPPass());                  // Constant prop with SCCP
 155
 156     // Run instcombine after redundancy elimination to exploit opportunities
 157     // opened up by them.
 158     PM->add(createInstructionCombiningPass());
 159     PM->add(createJumpThreadingPass());         // Thread jumps
 160     PM->add(createCorrelatedValuePropagationPass());
 161     PM->add(createDeadStoreEliminationPass());  // Delete dead stores
 162     PM->add(createAggressiveDCEPass());         // Delete dead instructions
 163     PM->add(createCFGSimplificationPass());     // Merge & remove BBs
 164
 165     if (UnitAtATime) {
 166       PM->add(createStripDeadPrototypesPass()); // Get rid of dead prototypes
 167       PM->add(createDeadTypeEliminationPass()); // Eliminate dead types
 168
 169       // GlobalOpt already deletes dead functions and globals, at -O3 try a
 170       // late pass of GlobalDCE.  It is capable of deleting dead cycles.
 171       if (OptimizationLevel > 2)
 172         PM->add(createGlobalDCEPass());         // Remove dead fns and globals.
 173
 174       if (OptimizationLevel > 1)
 175         PM->add(createConstantMergePass());       // Merge dup global constants
 176     }
 177   }
 178
 179   static inline void addOnePass(PassManagerBase *PM, Pass *P, bool AndVerify) {
 180     PM->add(P);
 181
 182     if (AndVerify)
 183       PM->add(createVerifierPass());
 184   }
 185
 186   static inline void createStandardLTOPasses(PassManagerBase *PM,
 187                                              bool Internalize,
 188                                              bool RunInliner,
 189                                              bool VerifyEach) {
 190     // Provide AliasAnalysis services for optimizations.
 191     createStandardAliasAnalysisPasses(PM);
 192
 193     // Now that composite has been compiled, scan through the module, looking
 194     // for a main function.  If main is defined, mark all other functions
 195     // internal.
 196     if (Internalize)
 197       addOnePass(PM, createInternalizePass(true), VerifyEach);
 198
 199     // Propagate constants at call sites into the functions they call.  This
 200     // opens opportunities for globalopt (and inlining) by substituting function
 201     // pointers passed as arguments to direct uses of functions.
 202     addOnePass(PM, createIPSCCPPass(), VerifyEach);
 203
 204     // Now that we internalized some globals, see if we can hack on them!
 205     addOnePass(PM, createGlobalOptimizerPass(), VerifyEach);
 206
 207     // Linking modules together can lead to duplicated global constants, only
 208     // keep one copy of each constant...
 209     addOnePass(PM, createConstantMergePass(), VerifyEach);
 210
 211     // Remove unused arguments from functions...
 212     addOnePass(PM, createDeadArgEliminationPass(), VerifyEach);
 213
 214     // Reduce the code after globalopt and ipsccp.  Both can open up significant
 215     // simplification opportunities, and both can propagate functions through
 216     // function pointers.  When this happens, we often have to resolve varargs
 217     // calls, etc, so let instcombine do this.
 218     addOnePass(PM, createInstructionCombiningPass(), VerifyEach);
 219
 220     // Inline small functions
 221     if (RunInliner)
 222       addOnePass(PM, createFunctionInliningPass(), VerifyEach);
 223
 224     addOnePass(PM, createPruneEHPass(), VerifyEach);   // Remove dead EH info.
 225     // Optimize globals again if we ran the inliner.
 226     if (RunInliner)
 227       addOnePass(PM, createGlobalOptimizerPass(), VerifyEach);
 228     addOnePass(PM, createGlobalDCEPass(), VerifyEach); // Remove dead functions.
 229
 230     // If we didn't decide to inline a function, check to see if we can
 231     // transform it to pass arguments by value instead of by reference.
 232     addOnePass(PM, createArgumentPromotionPass(), VerifyEach);
 233
 234     // The IPO passes may leave cruft around.  Clean up after them.
 235     addOnePass(PM, createInstructionCombiningPass(), VerifyEach);
 236     addOnePass(PM, createJumpThreadingPass(), VerifyEach);
 237     // Break up allocas
 238     addOnePass(PM, createScalarReplAggregatesPass(), VerifyEach);
 239
 240     // Run a few AA driven optimizations here and now, to cleanup the code.
 241     addOnePass(PM, createFunctionAttrsPass(), VerifyEach); // Add nocapture.
 242     addOnePass(PM, createGlobalsModRefPass(), VerifyEach); // IP alias analysis.
 243
 244     addOnePass(PM, createLICMPass(), VerifyEach);      // Hoist loop invariants.
 245     addOnePass(PM, createGVNPass(), VerifyEach);       // Remove redundancies.
 246     addOnePass(PM, createMemCpyOptPass(), VerifyEach); // Remove dead memcpys.
 247     // Nuke dead stores.
 248     addOnePass(PM, createDeadStoreEliminationPass(), VerifyEach);
 249
 250     // Cleanup and simplify the code after the scalar optimizations.
 251     addOnePass(PM, createInstructionCombiningPass(), VerifyEach);
 252
 253     addOnePass(PM, createJumpThreadingPass(), VerifyEach);
 254
 255     // Delete basic blocks, which optimization passes may have killed.
 256     addOnePass(PM, createCFGSimplificationPass(), VerifyEach);
 257
 258     // Now that we have optimized the program, discard unreachable functions.
 259     addOnePass(PM, createGlobalDCEPass(), VerifyEach);
 260   }
 261 }
 262
 263 #endif