1 //===-- Passes.h - Target independent code generation passes ----*- 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 interfaces to access the target independent code generation
11 // passes provided by the LLVM backend.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CODEGEN_PASSES_H
16 #define LLVM_CODEGEN_PASSES_H
18 #include "llvm/Target/TargetMachine.h"
24 class MachineFunctionPass;
27 class TargetRegisterClass;
30 /// createUnreachableBlockEliminationPass - The LLVM code generator does not
31 /// work well with unreachable basic blocks (what live ranges make sense for a
32 /// block that cannot be reached?). As such, a code generator should either
33 /// not instruction select unreachable blocks, or run this pass as its
34 /// last LLVM modifying pass to clean up blocks that are not reachable from
36 FunctionPass *createUnreachableBlockEliminationPass();
38 /// MachineFunctionPrinter pass - This pass prints out the machine function to
39 /// the given stream as a debugging tool.
41 createMachineFunctionPrinterPass(raw_ostream &OS,
42 const std::string &Banner ="");
44 /// MachineLoopInfo pass - This pass is a loop analysis pass.
46 extern char &MachineLoopInfoID;
48 /// MachineLoopRanges pass - This pass is an on-demand loop coverage
51 extern char &MachineLoopRangesID;
53 /// MachineDominators pass - This pass is a machine dominators analysis pass.
55 extern char &MachineDominatorsID;
57 /// EdgeBundles analysis - Bundle machine CFG edges.
59 extern char &EdgeBundlesID;
61 /// PHIElimination pass - This pass eliminates machine instruction PHI nodes
62 /// by inserting copy instructions. This destroys SSA information, but is the
63 /// desired input for some register allocators. This pass is "required" by
64 /// these register allocator like this: AU.addRequiredID(PHIEliminationID);
66 extern char &PHIEliminationID;
68 /// StrongPHIElimination pass - This pass eliminates machine instruction PHI
69 /// nodes by inserting copy instructions. This destroys SSA information, but
70 /// is the desired input for some register allocators. This pass is
71 /// "required" by these register allocator like this:
72 /// AU.addRequiredID(PHIEliminationID);
73 /// This pass is still in development
74 extern char &StrongPHIEliminationID;
76 /// LiveStacks pass. An analysis keeping track of the liveness of stack slots.
77 extern char &LiveStacksID;
79 /// TwoAddressInstruction pass - This pass reduces two-address instructions to
80 /// use two operands. This destroys SSA information but it is desired by
81 /// register allocators.
82 extern char &TwoAddressInstructionPassID;
84 /// RegisteCoalescer pass - This pass merges live ranges to eliminate copies.
85 extern char &RegisterCoalescerPassID;
87 /// MachineScheduler pass - This pass schedules machine instructions.
88 extern char &MachineSchedulerID;
90 /// SpillPlacement analysis. Suggest optimal placement of spill code between
93 extern char &SpillPlacementID;
95 /// UnreachableMachineBlockElimination pass - This pass removes unreachable
96 /// machine basic blocks.
97 extern char &UnreachableMachineBlockElimID;
99 /// DeadMachineInstructionElim pass - This pass removes dead machine
102 FunctionPass *createDeadMachineInstructionElimPass();
104 /// Creates a register allocator as the user specified on the command line, or
105 /// picks one that matches OptLevel.
107 FunctionPass *createRegisterAllocator(CodeGenOpt::Level OptLevel);
109 /// FastRegisterAllocation Pass - This pass register allocates as fast as
110 /// possible. It is best suited for debug code where live ranges are short.
112 FunctionPass *createFastRegisterAllocator();
114 /// BasicRegisterAllocation Pass - This pass implements a degenerate global
115 /// register allocator using the basic regalloc framework.
117 FunctionPass *createBasicRegisterAllocator();
119 /// Greedy register allocation pass - This pass implements a global register
120 /// allocator for optimized builds.
122 FunctionPass *createGreedyRegisterAllocator();
124 /// PBQPRegisterAllocation Pass - This pass implements the Partitioned Boolean
125 /// Quadratic Prograaming (PBQP) based register allocator.
127 FunctionPass *createDefaultPBQPRegisterAllocator();
129 /// PrologEpilogCodeInserter Pass - This pass inserts prolog and epilog code,
130 /// and eliminates abstract frame references.
132 FunctionPass *createPrologEpilogCodeInserter();
134 /// ExpandPostRAPseudos Pass - This pass expands pseudo instructions after
135 /// register allocation.
137 FunctionPass *createExpandPostRAPseudosPass();
139 /// createPostRAScheduler - This pass performs post register allocation
141 FunctionPass *createPostRAScheduler(CodeGenOpt::Level OptLevel);
143 /// BranchFolding Pass - This pass performs machine code CFG based
144 /// optimizations to delete branches to branches, eliminate branches to
145 /// successor blocks (creating fall throughs), and eliminating branches over
147 FunctionPass *createBranchFoldingPass(bool DefaultEnableTailMerge);
149 /// TailDuplicate Pass - Duplicate blocks with unconditional branches
150 /// into tails of their predecessors.
151 FunctionPass *createTailDuplicatePass(bool PreRegAlloc = false);
153 /// IfConverter Pass - This pass performs machine code if conversion.
154 FunctionPass *createIfConverterPass();
156 /// MachineBlockPlacement Pass - This pass places basic blocks based on branch
158 FunctionPass *createMachineBlockPlacementPass();
160 /// MachineBlockPlacementStats Pass - This pass collects statistics about the
161 /// basic block placement using branch probabilities and block frequency
163 FunctionPass *createMachineBlockPlacementStatsPass();
165 /// Code Placement Pass - This pass optimize code placement and aligns loop
166 /// headers to target specific alignment boundary.
167 FunctionPass *createCodePlacementOptPass();
169 /// IntrinsicLowering Pass - Performs target-independent LLVM IR
170 /// transformations for highly portable strategies.
171 FunctionPass *createGCLoweringPass();
173 /// MachineCodeAnalysis Pass - Target-independent pass to mark safe points in
174 /// machine code. Must be added very late during code generation, just prior
175 /// to output, and importantly after all CFG transformations (such as branch
177 FunctionPass *createGCMachineCodeAnalysisPass();
179 /// Deleter Pass - Releases GC metadata.
181 FunctionPass *createGCInfoDeleter();
183 /// Creates a pass to print GC metadata.
185 FunctionPass *createGCInfoPrinter(raw_ostream &OS);
187 /// createMachineCSEPass - This pass performs global CSE on machine
189 FunctionPass *createMachineCSEPass();
191 /// createMachineLICMPass - This pass performs LICM on machine instructions.
193 FunctionPass *createMachineLICMPass(bool PreRegAlloc = true);
195 /// createMachineSinkingPass - This pass performs sinking on machine
197 FunctionPass *createMachineSinkingPass();
199 /// createMachineCopyPropagationPass - This pass performs copy propagation on
200 /// machine instructions.
201 FunctionPass *createMachineCopyPropagationPass();
203 /// createPeepholeOptimizerPass - This pass performs peephole optimizations -
204 /// like extension and comparison eliminations.
205 FunctionPass *createPeepholeOptimizerPass();
207 /// createOptimizePHIsPass - This pass optimizes machine instruction PHIs
208 /// to take advantage of opportunities created during DAG legalization.
209 FunctionPass *createOptimizePHIsPass();
211 /// createStackSlotColoringPass - This pass performs stack slot coloring.
212 FunctionPass *createStackSlotColoringPass(bool);
214 /// createStackProtectorPass - This pass adds stack protectors to functions.
215 FunctionPass *createStackProtectorPass(const TargetLowering *tli);
217 /// createMachineVerifierPass - This pass verifies cenerated machine code
218 /// instructions for correctness.
219 FunctionPass *createMachineVerifierPass(const char *Banner = 0);
221 /// createDwarfEHPass - This pass mulches exception handling code into a form
222 /// adapted to code generation. Required if using dwarf exception handling.
223 FunctionPass *createDwarfEHPass(const TargetMachine *tm);
225 /// createSjLjEHPass - This pass adapts exception handling code to use
226 /// the GCC-style builtin setjmp/longjmp (sjlj) to handling EH control flow.
227 FunctionPass *createSjLjEHPass(const TargetLowering *tli);
229 /// createLocalStackSlotAllocationPass - This pass assigns local frame
230 /// indices to stack slots relative to one another and allocates
231 /// base registers to access them when it is estimated by the target to
232 /// be out of range of normal frame pointer or stack pointer index
234 FunctionPass *createLocalStackSlotAllocationPass();
236 /// createExpandISelPseudosPass - This pass expands pseudo-instructions.
238 FunctionPass *createExpandISelPseudosPass();
240 /// createExecutionDependencyFixPass - This pass fixes execution time
241 /// problems with dependent instructions, such as switching execution
242 /// domains to match.
244 /// The pass will examine instructions using and defining registers in RC.
246 FunctionPass *createExecutionDependencyFixPass(const TargetRegisterClass *RC);
248 /// createUnpackMachineBundles - This pass unpack machine instruction bundles.
250 FunctionPass *createUnpackMachineBundlesPass();
252 } // End llvm namespace