1 // llvm/Transforms/IPO/PassManagerBuilder.h - Build Standard Pass -*- C++ -*-=//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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++.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_SUPPORT_PASSMANAGERBUILDER_H
16 #define LLVM_SUPPORT_PASSMANAGERBUILDER_H
21 class TargetLibraryInfo;
22 class PassManagerBase;
24 class FunctionPassManager;
26 /// PassManagerBuilder - This class is used to set up a standard optimization
27 /// sequence for languages like C and C++, allowing some APIs to customize the
28 /// pass sequence in various ways. A simple example of using it would be:
30 /// PassManagerBuilder Builder;
31 /// Builder.OptLevel = 2;
32 /// Builder.populateFunctionPassManager(FPM);
33 /// Builder.populateModulePassManager(MPM);
35 /// In addition to setting up the basic passes, PassManagerBuilder allows
36 /// frontends to vend a plugin API, where plugins are allowed to add extensions
37 /// to the default pass manager. They do this by specifying where in the pass
38 /// pipeline they want to be added, along with a callback function that adds
39 /// the pass(es). For example, a plugin that wanted to add a loop optimization
40 /// could do something like this:
42 /// static void addMyLoopPass(const PMBuilder &Builder, PassManagerBase &PM) {
43 /// if (Builder.getOptLevel() > 2 && Builder.getOptSizeLevel() == 0)
44 /// PM.add(createMyAwesomePass());
47 /// Builder.addExtension(PassManagerBuilder::EP_LoopOptimizerEnd,
50 class PassManagerBuilder {
53 /// Extensions are passed the builder itself (so they can see how it is
54 /// configured) as well as the pass manager to add stuff to.
55 typedef void (*ExtensionFn)(const PassManagerBuilder &Builder,
57 enum ExtensionPointTy {
58 /// EP_EarlyAsPossible - This extension point allows adding passes before
59 /// any other transformations, allowing them to see the code as it is coming
60 /// out of the frontend.
63 /// EP_LoopOptimizerEnd - This extension point allows adding loop passes to
64 /// the end of the loop optimizer.
67 /// EP_ScalarOptimizerLate - This extension point allows adding optimization
68 /// passes after most of the main optimizations, but before the last
69 /// cleanup-ish optimizations.
70 EP_ScalarOptimizerLate
73 /// The Optimization Level - Specify the basic optimization level.
74 /// 0 = -O0, 1 = -O1, 2 = -O2, 3 = -O3
77 /// SizeLevel - How much we're optimizing for size.
78 /// 0 = none, 1 = -Os, 2 = -Oz
81 /// LibraryInfo - Specifies information about the runtime library for the
82 /// optimizer. If this is non-null, it is added to both the function and
83 /// per-module pass pipeline.
84 TargetLibraryInfo *LibraryInfo;
86 /// Inliner - Specifies the inliner to use. If this is non-null, it is
87 /// added to the per-module passes.
90 bool DisableSimplifyLibCalls;
91 bool DisableUnitAtATime;
92 bool DisableUnrollLoops;
95 /// ExtensionList - This is list of all of the extensions that are registered.
96 std::vector<std::pair<ExtensionPointTy, ExtensionFn> > Extensions;
100 ~PassManagerBuilder();
101 void addExtension(ExtensionPointTy Ty, ExtensionFn Fn);
104 void addExtensionsToPM(ExtensionPointTy ETy, PassManagerBase &PM) const;
105 void addInitialAliasAnalysisPasses(PassManagerBase &PM) const;
108 /// populateFunctionPassManager - This fills in the function pass manager,
109 /// which is expected to be run on each function immediately as it is
110 /// generated. The idea is to reduce the size of the IR in memory.
111 void populateFunctionPassManager(FunctionPassManager &FPM);
113 /// populateModulePassManager - This sets up the primary pass manager.
114 void populateModulePassManager(PassManagerBase &MPM);
115 void populateLTOPassManager(PassManagerBase &PM, bool Internalize,
119 } // end namespace llvm