#include <PassManagerBuilder.h>

Collaboration diagram for llvm::PassManagerBuilder:

Public Types
enum	ExtensionPointTy { EP_EarlyAsPossible, EP_ModuleOptimizerEarly, EP_LoopOptimizerEnd, EP_ScalarOptimizerLate, EP_OptimizerLast, EP_EnabledOnOptLevel0, EP_Peephole }
typedef void(*	ExtensionFn )(const PassManagerBuilder &Builder, PassManagerBase &PM)
Public Member Functions
	PassManagerBuilder ()
	~PassManagerBuilder ()
void	addExtension (ExtensionPointTy Ty, ExtensionFn Fn)
void	populateFunctionPassManager (FunctionPassManager &FPM)
void	populateModulePassManager (PassManagerBase &MPM)
	populateModulePassManager - This sets up the primary pass manager.
void	populateLTOPassManager (PassManagerBase &PM, TargetMachine *TM=nullptr)
Static Public Member Functions
static void	addGlobalExtension (ExtensionPointTy Ty, ExtensionFn Fn)
Public Attributes
unsigned	OptLevel
unsigned	SizeLevel
TargetLibraryInfo *	LibraryInfo
Pass *	Inliner
bool	DisableTailCalls
bool	DisableUnitAtATime
bool	DisableUnrollLoops
bool	BBVectorize
bool	SLPVectorize
bool	LoopVectorize
bool	RerollLoops
bool	LoadCombine
bool	DisableGVNLoadPRE
bool	VerifyInput
bool	VerifyOutput
bool	StripDebug
bool	MergeFunctions

Detailed Description

PassManagerBuilder - This class is used to set up a standard optimization sequence for languages like C and C++, allowing some APIs to customize the pass sequence in various ways. A simple example of using it would be:

PassManagerBuilder Builder; Builder.OptLevel = 2; Builder.populateFunctionPassManager(FPM); Builder.populateModulePassManager(MPM);

In addition to setting up the basic passes, PassManagerBuilder allows frontends to vend a plugin API, where plugins are allowed to add extensions to the default pass manager. They do this by specifying where in the pass pipeline they want to be added, along with a callback function that adds the pass(es). For example, a plugin that wanted to add a loop optimization could do something like this:

static void addMyLoopPass(const PMBuilder &Builder, PassManagerBase &PM) { if (Builder.getOptLevel() > 2 && Builder.getOptSizeLevel() == 0) PM.add(createMyAwesomePass()); } ... Builder.addExtension(PassManagerBuilder::EP_LoopOptimizerEnd, addMyLoopPass); ...

Definition at line 57 of file Transforms/IPO/PassManagerBuilder.h.

Member Typedef Documentation

typedef void(* llvm::PassManagerBuilder::ExtensionFn)(const PassManagerBuilder &Builder, PassManagerBase &PM)

Extensions are passed the builder itself (so they can see how it is configured) as well as the pass manager to add stuff to.

Definition at line 61 of file Transforms/IPO/PassManagerBuilder.h.

Member Enumeration Documentation

enum llvm::PassManagerBuilder::ExtensionPointTy

Enumerator:

EP_EarlyAsPossible	EP_EarlyAsPossible - This extension point allows adding passes before any other transformations, allowing them to see the code as it is coming out of the frontend.
EP_ModuleOptimizerEarly	EP_ModuleOptimizerEarly - This extension point allows adding passes just before the main module-level optimization passes.
EP_LoopOptimizerEnd	EP_LoopOptimizerEnd - This extension point allows adding loop passes to the end of the loop optimizer.
EP_ScalarOptimizerLate	EP_ScalarOptimizerLate - This extension point allows adding optimization passes after most of the main optimizations, but before the last cleanup-ish optimizations.
EP_OptimizerLast	EP_OptimizerLast -- This extension point allows adding passes that run after everything else.
EP_EnabledOnOptLevel0	EP_EnabledOnOptLevel0 - This extension point allows adding passes that should not be disabled by O0 optimization level. The passes will be inserted after the inlining pass.
EP_Peephole	EP_Peephole - This extension point allows adding passes that perform peephole optimizations similar to the instruction combiner. These passes will be inserted after each instance of the instruction combiner pass.

Definition at line 63 of file Transforms/IPO/PassManagerBuilder.h.

Constructor & Destructor Documentation

PassManagerBuilder::PassManagerBuilder ( )

Definition at line 77 of file PassManagerBuilder.cpp.

References BBVectorize, DisableGVNLoadPRE, DisableTailCalls, DisableUnitAtATime, DisableUnrollLoops, LibraryInfo, LoadCombine, LoopVectorize, MergeFunctions, OptLevel, RerollLoops, RunBBVectorization, RunLoadCombine, RunLoopRerolling, RunLoopVectorization, RunSLPVectorization, SizeLevel, SLPVectorize, StripDebug, VerifyInput, and VerifyOutput.

PassManagerBuilder::~PassManagerBuilder ( )

Definition at line 97 of file PassManagerBuilder.cpp.

References Inliner, and LibraryInfo.

Member Function Documentation

void PassManagerBuilder::addExtension	(	ExtensionPointTy	Ty,
		ExtensionFn	Fn
	)

Definition at line 112 of file PassManagerBuilder.cpp.

void PassManagerBuilder::addGlobalExtension	(	PassManagerBuilder::ExtensionPointTy	Ty,
		PassManagerBuilder::ExtensionFn	Fn
	)		`[static]`

Adds an extension that will be used by all PassManagerBuilder instances. This is intended to be used by plugins, to register a set of optimisations to run automatically.

Definition at line 106 of file PassManagerBuilder.cpp.

References GlobalExtensions.

Referenced by llvm::RegisterStandardPasses::RegisterStandardPasses().

void PassManagerBuilder::populateFunctionPassManager ( FunctionPassManager & FPM )

populateFunctionPassManager - This fills in the function pass manager, which is expected to be run on each function immediately as it is generated. The idea is to reduce the size of the IR in memory.

Definition at line 138 of file PassManagerBuilder.cpp.

References llvm::createCFGSimplificationPass(), llvm::createEarlyCSEPass(), llvm::createLowerExpectIntrinsicPass(), llvm::createScalarReplAggregatesPass(), llvm::createSROAPass(), EP_EarlyAsPossible, LibraryInfo, OptLevel, and UseNewSROA.

Referenced by LLVMPassManagerBuilderPopulateFunctionPassManager().

void PassManagerBuilder::populateLTOPassManager	(	PassManagerBase &	PM,
		TargetMachine *	TM = `nullptr`
	)

Definition at line 442 of file PassManagerBuilder.cpp.

References llvm::TargetMachine::addAnalysisPasses(), llvm::createDebugInfoVerifierPass(), llvm::createStripSymbolsPass(), llvm::createVerifierPass(), LibraryInfo, OptLevel, StripDebug, VerifyInput, and VerifyOutput.

Referenced by LLVMPassManagerBuilderPopulateLTOPassManager().

void PassManagerBuilder::populateModulePassManager ( PassManagerBase & MPM )

populateModulePassManager - This sets up the primary pass manager.

Definition at line 157 of file PassManagerBuilder.cpp.

Referenced by LLVMPassManagerBuilderPopulateModulePassManager().

Member Data Documentation

bool llvm::PassManagerBuilder::BBVectorize

Definition at line 117 of file Transforms/IPO/PassManagerBuilder.h.

Referenced by PassManagerBuilder(), and populateModulePassManager().

bool llvm::PassManagerBuilder::DisableGVNLoadPRE

Definition at line 122 of file Transforms/IPO/PassManagerBuilder.h.

Referenced by PassManagerBuilder(), and populateModulePassManager().

bool llvm::PassManagerBuilder::DisableTailCalls

Definition at line 114 of file Transforms/IPO/PassManagerBuilder.h.

Referenced by PassManagerBuilder(), and populateModulePassManager().

bool llvm::PassManagerBuilder::DisableUnitAtATime

Definition at line 115 of file Transforms/IPO/PassManagerBuilder.h.

Referenced by LLVMPassManagerBuilderSetDisableUnitAtATime(), PassManagerBuilder(), and populateModulePassManager().

bool llvm::PassManagerBuilder::DisableUnrollLoops

Definition at line 116 of file Transforms/IPO/PassManagerBuilder.h.

Referenced by LLVMPassManagerBuilderSetDisableUnrollLoops(), PassManagerBuilder(), and populateModulePassManager().

Pass* llvm::PassManagerBuilder::Inliner

Inliner - Specifies the inliner to use. If this is non-null, it is added to the per-module passes.

Definition at line 112 of file Transforms/IPO/PassManagerBuilder.h.

Referenced by LLVMPassManagerBuilderPopulateLTOPassManager(), LLVMPassManagerBuilderUseInlinerWithThreshold(), and ~PassManagerBuilder().

TargetLibraryInfo* llvm::PassManagerBuilder::LibraryInfo

LibraryInfo - Specifies information about the runtime library for the optimizer. If this is non-null, it is added to both the function and per-module pass pipeline.

Definition at line 108 of file Transforms/IPO/PassManagerBuilder.h.

Referenced by PassManagerBuilder(), populateFunctionPassManager(), populateLTOPassManager(), populateModulePassManager(), and ~PassManagerBuilder().