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 <iosfwd>
  19 #include <string>
  20
  21 namespace llvm {
  22
  23   class FunctionPass;
  24   class PassInfo;
  25   class TargetMachine;
  26   class RegisterCoalescer;
  27
  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
  33   /// the entry block.
  34   FunctionPass *createUnreachableBlockEliminationPass();
  35
  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 ="");
  40
  41   /// MachineLoopInfo pass - This pass is a loop analysis pass.
  42   ///
  43   extern const PassInfo *MachineLoopInfoID;
  44
  45   /// MachineDominators pass - This pass is a machine dominators analysis pass.
  46   ///
  47   extern const PassInfo *MachineDominatorsID;
  48
  49   /// PHIElimination pass - This pass eliminates machine instruction PHI nodes
  50   /// by inserting copy instructions.  This destroys SSA information, but is the
  51   /// desired input for some register allocators.  This pass is "required" by
  52   /// these register allocator like this: AU.addRequiredID(PHIEliminationID);
  53   ///
  54   extern const PassInfo *PHIEliminationID;
  55
  56   /// StrongPHIElimination pass - This pass eliminates machine instruction PHI
  57   /// nodes by inserting copy instructions.  This destroys SSA information, but
  58   /// is the desired input for some register allocators.  This pass is
  59   /// "required" by these register allocator like this:
  60   ///    AU.addRequiredID(PHIEliminationID);
  61   ///  This pass is still in development
  62   extern const PassInfo *StrongPHIEliminationID;
  63
  64   /// SimpleRegisterCoalescing pass.  Aggressively coalesces every register
  65   /// copy it can.
  66   ///
  67   extern const PassInfo *SimpleRegisterCoalescingID;
  68
  69   /// TwoAddressInstruction pass - This pass reduces two-address instructions to
  70   /// use two operands. This destroys SSA information but it is desired by
  71   /// register allocators.
  72   extern const PassInfo *TwoAddressInstructionPassID;
  73
  74   /// Creates a register allocator as the user specified on the command line.
  75   ///
  76   FunctionPass *createRegisterAllocator();
  77
  78   /// SimpleRegisterAllocation Pass - This pass converts the input machine code
  79   /// from SSA form to use explicit registers by spilling every register.  Wow,
  80   /// great policy huh?
  81   ///
  82   FunctionPass *createSimpleRegisterAllocator();
  83
  84   /// LocalRegisterAllocation Pass - This pass register allocates the input code
  85   /// a basic block at a time, yielding code better than the simple register
  86   /// allocator, but not as good as a global allocator.
  87   ///
  88   FunctionPass *createLocalRegisterAllocator();
  89
  90   /// BigBlockRegisterAllocation Pass - The BigBlock register allocator
  91   /// munches single basic blocks at a time, like the local register
  92   /// allocator.  While the BigBlock allocator is a little slower, and uses
  93   /// somewhat more memory than the local register allocator, it tends to
  94   /// yield the best allocations (of any of the allocators) for blocks that
  95   /// have hundreds or thousands of instructions in sequence.
  96   ///
  97   FunctionPass *createBigBlockRegisterAllocator();
  98
  99   /// LinearScanRegisterAllocation Pass - This pass implements the linear scan
 100   /// register allocation algorithm, a global register allocator.
 101   ///
 102   FunctionPass *createLinearScanRegisterAllocator();
 103
 104   /// SimpleRegisterCoalescing Pass - Coalesce all copies possible.  Can run
 105   /// independently of the register allocator.
 106   ///
 107   RegisterCoalescer *createSimpleRegisterCoalescer();
 108
 109   /// PrologEpilogCodeInserter Pass - This pass inserts prolog and epilog code,
 110   /// and eliminates abstract frame references.
 111   ///
 112   FunctionPass *createPrologEpilogCodeInserter();
 113
 114   /// LowerSubregs Pass - This pass lowers subregs to register-register copies
 115   /// which yields suboptimal, but correct code if the register allocator
 116   /// cannot coalesce all subreg operations during allocation.
 117   ///
 118   FunctionPass *createLowerSubregsPass();
 119
 120   /// createPostRAScheduler - under development.
 121   FunctionPass *createPostRAScheduler();
 122
 123   /// BranchFolding Pass - This pass performs machine code CFG based
 124   /// optimizations to delete branches to branches, eliminate branches to
 125   /// successor blocks (creating fall throughs), and eliminating branches over
 126   /// branches.
 127   FunctionPass *createBranchFoldingPass(bool DefaultEnableTailMerge);
 128
 129   /// IfConverter Pass - This pass performs machine code if conversion.
 130   FunctionPass *createIfConverterPass();
 131
 132   /// LoopAligner Pass - This pass aligns loop headers to target specific
 133   /// alignment boundary.
 134   FunctionPass *createLoopAlignerPass();
 135
 136   /// DebugLabelFoldingPass - This pass prunes out redundant debug labels.  This
 137   /// allows a debug emitter to determine if the range of two labels is empty,
 138   /// by seeing if the labels map to the same reduced label.
 139   FunctionPass *createDebugLabelFoldingPass();
 140
 141   /// MachineCodeDeletion Pass - This pass deletes all of the machine code for
 142   /// the current function, which should happen after the function has been
 143   /// emitted to a .s file or to memory.
 144   FunctionPass *createMachineCodeDeleter();
 145
 146   /// getRegisterAllocator - This creates an instance of the register allocator
 147   /// for the Sparc.
 148   FunctionPass *getRegisterAllocator(TargetMachine &T);
 149
 150   /// IntrinsicLowering Pass - Performs target-independent LLVM IR
 151   /// transformations for highly portable collectors.
 152   FunctionPass *createGCLoweringPass();
 153
 154   /// MachineCodeAnalysis Pass - Target-independent pass to mark safe points in
 155   /// machine code. Must be added very late during code generation, just prior
 156   /// to output, and importantly after all CFG transformations (such as branch
 157   /// folding).
 158   FunctionPass *createGCMachineCodeAnalysisPass();
 159
 160   /// Deleter Pass - Releases collector metadata.
 161   ///
 162   FunctionPass *createCollectorMetadataDeleter();
 163
 164   /// Creates a pass to print collector metadata.
 165   ///
 166   FunctionPass *createCollectorMetadataPrinter(std::ostream &OS);
 167
 168   /// createMachineLICMPass - This pass performs LICM on machine instructions.
 169   ///
 170   FunctionPass *createMachineLICMPass();
 171
 172   /// createMachineSinkingPass - This pass performs sinking on machine
 173   /// instructions.
 174   FunctionPass *createMachineSinkingPass();
 175
 176 } // End llvm namespace
 177
 178 #endif