1 //===-- Passes.h - Target independent code generation passes ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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
26 class RegisterCoalescer;
28 /// createUnreachableBlockEliminationPass - The LLVM code generator does not
29 /// work well with unreachable basic blocks (what live ranges make sense for a
30 /// block that cannot be reached?). As such, a code generator should either
31 /// not instruction select unreachable blocks, or it can run this pass as it's
32 /// last LLVM modifying pass to clean up blocks that are not reachable from
34 FunctionPass *createUnreachableBlockEliminationPass();
36 /// MachineFunctionPrinter pass - This pass prints out the machine function to
37 /// standard error, as a debugging tool.
38 FunctionPass *createMachineFunctionPrinterPass(std::ostream *OS,
39 const std::string &Banner ="");
41 /// PHIElimination pass - This pass eliminates machine instruction PHI nodes
42 /// by inserting copy instructions. This destroys SSA information, but is the
43 /// desired input for some register allocators. This pass is "required" by
44 /// these register allocator like this: AU.addRequiredID(PHIEliminationID);
46 extern const PassInfo *PHIEliminationID;
48 /// SimpleRegisterCoalescing pass. Aggressively coalesces every register
51 extern const PassInfo *SimpleRegisterCoalescingID;
53 /// TwoAddressInstruction pass - This pass reduces two-address instructions to
54 /// use two operands. This destroys SSA information but it is desired by
55 /// register allocators.
56 extern const PassInfo *TwoAddressInstructionPassID;
58 /// Creates a register allocator as the user specified on the command line.
60 FunctionPass *createRegisterAllocator();
62 /// SimpleRegisterAllocation Pass - This pass converts the input machine code
63 /// from SSA form to use explicit registers by spilling every register. Wow,
66 FunctionPass *createSimpleRegisterAllocator();
68 /// LocalRegisterAllocation Pass - This pass register allocates the input code
69 /// a basic block at a time, yielding code better than the simple register
70 /// allocator, but not as good as a global allocator.
72 FunctionPass *createLocalRegisterAllocator();
74 /// BigBlockRegisterAllocation Pass - The BigBlock register allocator
75 /// munches single basic blocks at a time, like the local register
76 /// allocator. While the BigBlock allocator is a little slower, and uses
77 /// somewhat more memory than the local register allocator, it tends to
78 /// yield the best allocations (of any of the allocators) for blocks that
79 /// have hundreds or thousands of instructions in sequence.
81 FunctionPass *createBigBlockRegisterAllocator();
83 /// LinearScanRegisterAllocation Pass - This pass implements the linear scan
84 /// register allocation algorithm, a global register allocator.
86 FunctionPass *createLinearScanRegisterAllocator();
88 /// SimpleRegisterCoalescing Pass - Coalesce all copies possible. Can run
89 /// independently of the register allocator.
91 RegisterCoalescer *createSimpleRegisterCoalescer();
93 /// PrologEpilogCodeInserter Pass - This pass inserts prolog and epilog code,
94 /// and eliminates abstract frame references.
96 FunctionPass *createPrologEpilogCodeInserter();
98 /// LowerSubregs Pass - This pass lowers subregs to register-register copies
99 /// which yields suboptimal, but correct code if the register allocator
100 /// cannot coalesce all subreg operations during allocation.
102 FunctionPass *createLowerSubregsPass();
104 /// createPostRAScheduler - under development.
105 FunctionPass *createPostRAScheduler();
107 /// BranchFolding Pass - This pass performs machine code CFG based
108 /// optimizations to delete branches to branches, eliminate branches to
109 /// successor blocks (creating fall throughs), and eliminating branches over
111 FunctionPass *createBranchFoldingPass(bool DefaultEnableTailMerge);
113 /// IfConverter Pass - This pass performs machine code if conversion.
114 FunctionPass *createIfConverterPass();
116 /// DebugLabelFoldingPass - This pass prunes out redundant debug labels. This
117 /// allows a debug emitter to determine if the range of two labels is empty,
118 /// by seeing if the labels map to the same reduced label.
119 FunctionPass *createDebugLabelFoldingPass();
121 /// MachineCodeDeletion Pass - This pass deletes all of the machine code for
122 /// the current function, which should happen after the function has been
123 /// emitted to a .s file or to memory.
124 FunctionPass *createMachineCodeDeleter();
126 /// getRegisterAllocator - This creates an instance of the register allocator
128 FunctionPass *getRegisterAllocator(TargetMachine &T);
130 } // End llvm namespace