include/llvm/CodeGen/Passes.h

   1 //===-- Passes.h - Target independent code generation passes ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines interfaces to access the target independent code generation
  11 // passes provided by the LLVM backend.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CODEGEN_PASSES_H
  16 #define LLVM_CODEGEN_PASSES_H
  17
  18 #include "llvm/Target/TargetMachine.h"
  19 #include <string>
  20
  21 namespace llvm {
  22
  23   class FunctionPass;
  24   class MachineFunctionPass;
  25   class PassInfo;
  26   class TargetLowering;
  27   class TargetRegisterClass;
  28   class raw_ostream;
  29
  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
  35   /// the entry block.
  36   FunctionPass *createUnreachableBlockEliminationPass();
  37
  38   /// MachineFunctionPrinter pass - This pass prints out the machine function to
  39   /// the given stream as a debugging tool.
  40   MachineFunctionPass *
  41   createMachineFunctionPrinterPass(raw_ostream &OS,
  42                                    const std::string &Banner ="");
  43
  44   /// MachineLoopInfo pass - This pass is a loop analysis pass.
  45   ///
  46   extern char &MachineLoopInfoID;
  47
  48   /// MachineLoopRanges pass - This pass is an on-demand loop coverage
  49   /// analysis pass.
  50   ///
  51   extern char &MachineLoopRangesID;
  52
  53   /// MachineDominators pass - This pass is a machine dominators analysis pass.
  54   ///
  55   extern char &MachineDominatorsID;
  56
  57   /// EdgeBundles analysis - Bundle machine CFG edges.
  58   ///
  59   extern char &EdgeBundlesID;
  60
  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);
  65   ///
  66   extern char &PHIEliminationID;
  67
  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;
  75
  76   /// LiveStacks pass. An analysis keeping track of the liveness of stack slots.
  77   extern char &LiveStacksID;
  78
  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;
  83
  84   /// RegisteCoalescer pass - This pass merges live ranges to eliminate copies.
  85   extern char &RegisterCoalescerPassID;
  86
  87   /// SpillPlacement analysis. Suggest optimal placement of spill code between
  88   /// basic blocks.
  89   ///
  90   extern char &SpillPlacementID;
  91
  92   /// UnreachableMachineBlockElimination pass - This pass removes unreachable
  93   /// machine basic blocks.
  94   extern char &UnreachableMachineBlockElimID;
  95
  96   /// DeadMachineInstructionElim pass - This pass removes dead machine
  97   /// instructions.
  98   ///
  99   FunctionPass *createDeadMachineInstructionElimPass();
 100
 101   /// Creates a register allocator as the user specified on the command line, or
 102   /// picks one that matches OptLevel.
 103   ///
 104   FunctionPass *createRegisterAllocator(CodeGenOpt::Level OptLevel);
 105
 106   /// FastRegisterAllocation Pass - This pass register allocates as fast as
 107   /// possible. It is best suited for debug code where live ranges are short.
 108   ///
 109   FunctionPass *createFastRegisterAllocator();
 110
 111   /// BasicRegisterAllocation Pass - This pass implements a degenerate global
 112   /// register allocator using the basic regalloc framework.
 113   ///
 114   FunctionPass *createBasicRegisterAllocator();
 115
 116   /// Greedy register allocation pass - This pass implements a global register
 117   /// allocator for optimized builds.
 118   ///
 119   FunctionPass *createGreedyRegisterAllocator();
 120
 121   /// PBQPRegisterAllocation Pass - This pass implements the Partitioned Boolean
 122   /// Quadratic Prograaming (PBQP) based register allocator.
 123   ///
 124   FunctionPass *createDefaultPBQPRegisterAllocator();
 125
 126   /// PrologEpilogCodeInserter Pass - This pass inserts prolog and epilog code,
 127   /// and eliminates abstract frame references.
 128   ///
 129   FunctionPass *createPrologEpilogCodeInserter();
 130
 131   /// ExpandPostRAPseudos Pass - This pass expands pseudo instructions after
 132   /// register allocation.
 133   ///
 134   FunctionPass *createExpandPostRAPseudosPass();
 135
 136   /// createPostRAScheduler - This pass performs post register allocation
 137   /// scheduling.
 138   FunctionPass *createPostRAScheduler(CodeGenOpt::Level OptLevel);
 139
 140   /// BranchFolding Pass - This pass performs machine code CFG based
 141   /// optimizations to delete branches to branches, eliminate branches to
 142   /// successor blocks (creating fall throughs), and eliminating branches over
 143   /// branches.
 144   FunctionPass *createBranchFoldingPass(bool DefaultEnableTailMerge);
 145
 146   /// TailDuplicate Pass - Duplicate blocks with unconditional branches
 147   /// into tails of their predecessors.
 148   FunctionPass *createTailDuplicatePass(bool PreRegAlloc = false);
 149
 150   /// IfConverter Pass - This pass performs machine code if conversion.
 151   FunctionPass *createIfConverterPass();
 152
 153   /// MachineBlockPlacement Pass - This pass places basic blocks based on branch
 154   /// probabilities.
 155   FunctionPass *createMachineBlockPlacementPass();
 156
 157   /// MachineBlockPlacementStats Pass - This pass collects statistics about the
 158   /// basic block placement using branch probabilities and block frequency
 159   /// information.
 160   FunctionPass *createMachineBlockPlacementStatsPass();
 161
 162   /// Code Placement Pass - This pass optimize code placement and aligns loop
 163   /// headers to target specific alignment boundary.
 164   FunctionPass *createCodePlacementOptPass();
 165
 166   /// IntrinsicLowering Pass - Performs target-independent LLVM IR
 167   /// transformations for highly portable strategies.
 168   FunctionPass *createGCLoweringPass();
 169
 170   /// MachineCodeAnalysis Pass - Target-independent pass to mark safe points in
 171   /// machine code. Must be added very late during code generation, just prior
 172   /// to output, and importantly after all CFG transformations (such as branch
 173   /// folding).
 174   FunctionPass *createGCMachineCodeAnalysisPass();
 175
 176   /// Deleter Pass - Releases GC metadata.
 177   ///
 178   FunctionPass *createGCInfoDeleter();
 179
 180   /// Creates a pass to print GC metadata.
 181   ///
 182   FunctionPass *createGCInfoPrinter(raw_ostream &OS);
 183
 184   /// createMachineCSEPass - This pass performs global CSE on machine
 185   /// instructions.
 186   FunctionPass *createMachineCSEPass();
 187
 188   /// createMachineLICMPass - This pass performs LICM on machine instructions.
 189   ///
 190   FunctionPass *createMachineLICMPass(bool PreRegAlloc = true);
 191
 192   /// createMachineSinkingPass - This pass performs sinking on machine
 193   /// instructions.
 194   FunctionPass *createMachineSinkingPass();
 195
 196   /// createMachineCopyPropagationPass - This pass performs copy propagation on
 197   /// machine instructions.
 198   FunctionPass *createMachineCopyPropagationPass();
 199
 200   /// createPeepholeOptimizerPass - This pass performs peephole optimizations -
 201   /// like extension and comparison eliminations.
 202   FunctionPass *createPeepholeOptimizerPass();
 203
 204   /// createOptimizePHIsPass - This pass optimizes machine instruction PHIs
 205   /// to take advantage of opportunities created during DAG legalization.
 206   FunctionPass *createOptimizePHIsPass();
 207
 208   /// createStackSlotColoringPass - This pass performs stack slot coloring.
 209   FunctionPass *createStackSlotColoringPass(bool);
 210
 211   /// createStackProtectorPass - This pass adds stack protectors to functions.
 212   FunctionPass *createStackProtectorPass(const TargetLowering *tli);
 213
 214   /// createMachineVerifierPass - This pass verifies cenerated machine code
 215   /// instructions for correctness.
 216   FunctionPass *createMachineVerifierPass(const char *Banner = 0);
 217
 218   /// createDwarfEHPass - This pass mulches exception handling code into a form
 219   /// adapted to code generation.  Required if using dwarf exception handling.
 220   FunctionPass *createDwarfEHPass(const TargetMachine *tm);
 221
 222   /// createSjLjEHPass - This pass adapts exception handling code to use
 223   /// the GCC-style builtin setjmp/longjmp (sjlj) to handling EH control flow.
 224   FunctionPass *createSjLjEHPass(const TargetLowering *tli);
 225
 226   /// createLocalStackSlotAllocationPass - This pass assigns local frame
 227   /// indices to stack slots relative to one another and allocates
 228   /// base registers to access them when it is estimated by the target to
 229   /// be out of range of normal frame pointer or stack pointer index
 230   /// addressing.
 231   FunctionPass *createLocalStackSlotAllocationPass();
 232
 233   /// createExpandISelPseudosPass - This pass expands pseudo-instructions.
 234   ///
 235   FunctionPass *createExpandISelPseudosPass();
 236
 237   /// createExecutionDependencyFixPass - This pass fixes execution time
 238   /// problems with dependent instructions, such as switching execution
 239   /// domains to match.
 240   ///
 241   /// The pass will examine instructions using and defining registers in RC.
 242   ///
 243   FunctionPass *createExecutionDependencyFixPass(const TargetRegisterClass *RC);
 244
 245   /// createUnpackMachineBundles - This pass unpack machine instruction bundles.
 246   ///
 247   FunctionPass *createUnpackMachineBundlesPass();
 248
 249 } // End llvm namespace
 250
 251 #endif