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;
29 /// createUnreachableBlockEliminationPass - The LLVM code generator does not
30 /// work well with unreachable basic blocks (what live ranges make sense for a
31 /// block that cannot be reached?). As such, a code generator should either
32 /// not instruction select unreachable blocks, or run this pass as its
33 /// last LLVM modifying pass to clean up blocks that are not reachable from
35 FunctionPass *createUnreachableBlockEliminationPass();
37 /// MachineFunctionPrinter pass - This pass prints out the machine function to
38 /// the given stream as a debugging tool.
40 createMachineFunctionPrinterPass(raw_ostream &OS,
41 const std::string &Banner ="");
43 /// MachineLoopInfo pass - This pass is a loop analysis pass.
45 extern char &MachineLoopInfoID;
47 /// MachineLoopRanges pass - This pass is an on-demand loop coverage
50 extern char &MachineLoopRangesID;
52 /// MachineDominators pass - This pass is a machine dominators analysis pass.
54 extern char &MachineDominatorsID;
56 /// EdgeBundles analysis - Bundle machine CFG edges.
58 extern char &EdgeBundlesID;
60 /// PHIElimination pass - This pass eliminates machine instruction PHI nodes
61 /// by inserting copy instructions. This destroys SSA information, but is the
62 /// desired input for some register allocators. This pass is "required" by
63 /// these register allocator like this: AU.addRequiredID(PHIEliminationID);
65 extern char &PHIEliminationID;
67 /// StrongPHIElimination pass - This pass eliminates machine instruction PHI
68 /// nodes by inserting copy instructions. This destroys SSA information, but
69 /// is the desired input for some register allocators. This pass is
70 /// "required" by these register allocator like this:
71 /// AU.addRequiredID(PHIEliminationID);
72 /// This pass is still in development
73 extern char &StrongPHIEliminationID;
75 /// LiveStacks pass. An analysis keeping track of the liveness of stack slots.
76 extern char &LiveStacksID;
78 /// TwoAddressInstruction pass - This pass reduces two-address instructions to
79 /// use two operands. This destroys SSA information but it is desired by
80 /// register allocators.
81 extern char &TwoAddressInstructionPassID;
83 /// RegisteCoalescer pass - This pass merges live ranges to eliminate copies.
84 extern char &RegisterCoalescerPassID;
86 /// SpillPlacement analysis. Suggest optimal placement of spill code between
89 extern char &SpillPlacementID;
91 /// UnreachableMachineBlockElimination pass - This pass removes unreachable
92 /// machine basic blocks.
93 extern char &UnreachableMachineBlockElimID;
95 /// DeadMachineInstructionElim pass - This pass removes dead machine
98 FunctionPass *createDeadMachineInstructionElimPass();
100 /// Creates a register allocator as the user specified on the command line, or
101 /// picks one that matches OptLevel.
103 FunctionPass *createRegisterAllocator(CodeGenOpt::Level OptLevel);
105 /// FastRegisterAllocation Pass - This pass register allocates as fast as
106 /// possible. It is best suited for debug code where live ranges are short.
108 FunctionPass *createFastRegisterAllocator();
110 /// BasicRegisterAllocation Pass - This pass implements a degenerate global
111 /// register allocator using the basic regalloc framework.
113 FunctionPass *createBasicRegisterAllocator();
115 /// Greedy register allocation pass - This pass implements a global register
116 /// allocator for optimized builds.
118 FunctionPass *createGreedyRegisterAllocator();
120 /// LinearScanRegisterAllocation Pass - This pass implements the linear scan
121 /// register allocation algorithm, a global register allocator.
123 FunctionPass *createLinearScanRegisterAllocator();
125 /// PBQPRegisterAllocation Pass - This pass implements the Partitioned Boolean
126 /// Quadratic Prograaming (PBQP) based register allocator.
128 FunctionPass *createDefaultPBQPRegisterAllocator();
130 /// PrologEpilogCodeInserter Pass - This pass inserts prolog and epilog code,
131 /// and eliminates abstract frame references.
133 FunctionPass *createPrologEpilogCodeInserter();
135 /// LowerSubregs Pass - This pass lowers subregs to register-register copies
136 /// which yields suboptimal, but correct code if the register allocator
137 /// cannot coalesce all subreg operations during allocation.
139 FunctionPass *createLowerSubregsPass();
141 /// createPostRAScheduler - This pass performs post register allocation
143 FunctionPass *createPostRAScheduler(CodeGenOpt::Level OptLevel);
145 /// BranchFolding Pass - This pass performs machine code CFG based
146 /// optimizations to delete branches to branches, eliminate branches to
147 /// successor blocks (creating fall throughs), and eliminating branches over
149 FunctionPass *createBranchFoldingPass(bool DefaultEnableTailMerge);
151 /// TailDuplicate Pass - Duplicate blocks with unconditional branches
152 /// into tails of their predecessors.
153 FunctionPass *createTailDuplicatePass(bool PreRegAlloc = false);
155 /// IfConverter Pass - This pass performs machine code if conversion.
156 FunctionPass *createIfConverterPass();
158 /// Code Placement Pass - This pass optimize code placement and aligns loop
159 /// headers to target specific alignment boundary.
160 FunctionPass *createCodePlacementOptPass();
162 /// IntrinsicLowering Pass - Performs target-independent LLVM IR
163 /// transformations for highly portable strategies.
164 FunctionPass *createGCLoweringPass();
166 /// MachineCodeAnalysis Pass - Target-independent pass to mark safe points in
167 /// machine code. Must be added very late during code generation, just prior
168 /// to output, and importantly after all CFG transformations (such as branch
170 FunctionPass *createGCMachineCodeAnalysisPass();
172 /// Deleter Pass - Releases GC metadata.
174 FunctionPass *createGCInfoDeleter();
176 /// Creates a pass to print GC metadata.
178 FunctionPass *createGCInfoPrinter(raw_ostream &OS);
180 /// createMachineCSEPass - This pass performs global CSE on machine
182 FunctionPass *createMachineCSEPass();
184 /// createMachineLICMPass - This pass performs LICM on machine instructions.
186 FunctionPass *createMachineLICMPass(bool PreRegAlloc = true);
188 /// createMachineSinkingPass - This pass performs sinking on machine
190 FunctionPass *createMachineSinkingPass();
192 /// createPeepholeOptimizerPass - This pass performs peephole optimizations -
193 /// like extension and comparison eliminations.
194 FunctionPass *createPeepholeOptimizerPass();
196 /// createOptimizePHIsPass - This pass optimizes machine instruction PHIs
197 /// to take advantage of opportunities created during DAG legalization.
198 FunctionPass *createOptimizePHIsPass();
200 /// createStackSlotColoringPass - This pass performs stack slot coloring.
201 FunctionPass *createStackSlotColoringPass(bool);
203 /// createStackProtectorPass - This pass adds stack protectors to functions.
204 FunctionPass *createStackProtectorPass(const TargetLowering *tli);
206 /// createMachineVerifierPass - This pass verifies cenerated machine code
207 /// instructions for correctness.
208 FunctionPass *createMachineVerifierPass(const char *Banner = 0);
210 /// createDwarfEHPass - This pass mulches exception handling code into a form
211 /// adapted to code generation. Required if using dwarf exception handling.
212 FunctionPass *createDwarfEHPass(const TargetMachine *tm);
214 /// createSjLjEHPass - This pass adapts exception handling code to use
215 /// the GCC-style builtin setjmp/longjmp (sjlj) to handling EH control flow.
216 FunctionPass *createSjLjEHPass(const TargetLowering *tli);
218 /// createLocalStackSlotAllocationPass - This pass assigns local frame
219 /// indices to stack slots relative to one another and allocates
220 /// base registers to access them when it is estimated by the target to
221 /// be out of range of normal frame pointer or stack pointer index
223 FunctionPass *createLocalStackSlotAllocationPass();
225 /// createExpandISelPseudosPass - This pass expands pseudo-instructions.
227 FunctionPass *createExpandISelPseudosPass();
229 } // End llvm namespace