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 RegisterCoalescer;
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 /// SpillPlacement analysis. Suggest optimal placement of spill code between
87 extern char &SpillPlacementID;
89 /// UnreachableMachineBlockElimination pass - This pass removes unreachable
90 /// machine basic blocks.
91 extern char &UnreachableMachineBlockElimID;
93 /// DeadMachineInstructionElim pass - This pass removes dead machine
96 FunctionPass *createDeadMachineInstructionElimPass();
98 /// Creates a register allocator as the user specified on the command line, or
99 /// picks one that matches OptLevel.
101 FunctionPass *createRegisterAllocator(CodeGenOpt::Level OptLevel);
103 /// FastRegisterAllocation Pass - This pass register allocates as fast as
104 /// possible. It is best suited for debug code where live ranges are short.
106 FunctionPass *createFastRegisterAllocator();
108 /// BasicRegisterAllocation Pass - This pass implements a degenerate global
109 /// register allocator using the basic regalloc framework.
111 FunctionPass *createBasicRegisterAllocator();
113 /// Greedy register allocation pass - This pass implements a global register
114 /// allocator for optimized builds.
116 FunctionPass *createGreedyRegisterAllocator();
118 /// LinearScanRegisterAllocation Pass - This pass implements the linear scan
119 /// register allocation algorithm, a global register allocator.
121 FunctionPass *createLinearScanRegisterAllocator();
123 /// PBQPRegisterAllocation Pass - This pass implements the Partitioned Boolean
124 /// Quadratic Prograaming (PBQP) based register allocator.
126 FunctionPass *createDefaultPBQPRegisterAllocator();
128 /// RegisterCoalescer Pass - Coalesce all copies possible. Can run
129 /// independently of the register allocator.
131 RegisterCoalescer *createRegisterCoalescer();
133 /// PrologEpilogCodeInserter Pass - This pass inserts prolog and epilog code,
134 /// and eliminates abstract frame references.
136 FunctionPass *createPrologEpilogCodeInserter();
138 /// LowerSubregs Pass - This pass lowers subregs to register-register copies
139 /// which yields suboptimal, but correct code if the register allocator
140 /// cannot coalesce all subreg operations during allocation.
142 FunctionPass *createLowerSubregsPass();
144 /// createPostRAScheduler - This pass performs post register allocation
146 FunctionPass *createPostRAScheduler(CodeGenOpt::Level OptLevel);
148 /// BranchFolding Pass - This pass performs machine code CFG based
149 /// optimizations to delete branches to branches, eliminate branches to
150 /// successor blocks (creating fall throughs), and eliminating branches over
152 FunctionPass *createBranchFoldingPass(bool DefaultEnableTailMerge);
154 /// TailDuplicate Pass - Duplicate blocks with unconditional branches
155 /// into tails of their predecessors.
156 FunctionPass *createTailDuplicatePass(bool PreRegAlloc = false);
158 /// IfConverter Pass - This pass performs machine code if conversion.
159 FunctionPass *createIfConverterPass();
161 /// Code Placement Pass - This pass optimize code placement and aligns loop
162 /// headers to target specific alignment boundary.
163 FunctionPass *createCodePlacementOptPass();
165 /// IntrinsicLowering Pass - Performs target-independent LLVM IR
166 /// transformations for highly portable strategies.
167 FunctionPass *createGCLoweringPass();
169 /// MachineCodeAnalysis Pass - Target-independent pass to mark safe points in
170 /// machine code. Must be added very late during code generation, just prior
171 /// to output, and importantly after all CFG transformations (such as branch
173 FunctionPass *createGCMachineCodeAnalysisPass();
175 /// Deleter Pass - Releases GC metadata.
177 FunctionPass *createGCInfoDeleter();
179 /// Creates a pass to print GC metadata.
181 FunctionPass *createGCInfoPrinter(raw_ostream &OS);
183 /// createMachineCSEPass - This pass performs global CSE on machine
185 FunctionPass *createMachineCSEPass();
187 /// createMachineLICMPass - This pass performs LICM on machine instructions.
189 FunctionPass *createMachineLICMPass(bool PreRegAlloc = true);
191 /// createMachineSinkingPass - This pass performs sinking on machine
193 FunctionPass *createMachineSinkingPass();
195 /// createPeepholeOptimizerPass - This pass performs peephole optimizations -
196 /// like extension and comparison eliminations.
197 FunctionPass *createPeepholeOptimizerPass();
199 /// createOptimizePHIsPass - This pass optimizes machine instruction PHIs
200 /// to take advantage of opportunities created during DAG legalization.
201 FunctionPass *createOptimizePHIsPass();
203 /// createStackSlotColoringPass - This pass performs stack slot coloring.
204 FunctionPass *createStackSlotColoringPass(bool);
206 /// createStackProtectorPass - This pass adds stack protectors to functions.
207 FunctionPass *createStackProtectorPass(const TargetLowering *tli);
209 /// createMachineVerifierPass - This pass verifies cenerated machine code
210 /// instructions for correctness.
211 FunctionPass *createMachineVerifierPass(const char *Banner = 0);
213 /// createDwarfEHPass - This pass mulches exception handling code into a form
214 /// adapted to code generation. Required if using dwarf exception handling.
215 FunctionPass *createDwarfEHPass(const TargetMachine *tm);
217 /// createSjLjEHPass - This pass adapts exception handling code to use
218 /// the GCC-style builtin setjmp/longjmp (sjlj) to handling EH control flow.
219 FunctionPass *createSjLjEHPass(const TargetLowering *tli);
221 /// createLocalStackSlotAllocationPass - This pass assigns local frame
222 /// indices to stack slots relative to one another and allocates
223 /// base registers to access them when it is estimated by the target to
224 /// be out of range of normal frame pointer or stack pointer index
226 FunctionPass *createLocalStackSlotAllocationPass();
228 /// createExpandISelPseudosPass - This pass expands pseudo-instructions.
230 FunctionPass *createExpandISelPseudosPass();
232 } // End llvm namespace