The CorrelatedExpressionElimination pass is known to be buggy. Remove it.
[oota-llvm.git] / include / llvm / Transforms / Scalar.h
index ae4e6538786a24810de2efb067687fe02af42ae8..8e06dc8271190cd842fdeac653c5ee8f214a18a7 100644 (file)
@@ -1,10 +1,10 @@
 //===-- Scalar.h - Scalar Transformations -----------------------*- C++ -*-===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
 //===----------------------------------------------------------------------===//
 //
 // This header file defines prototypes for accessor functions that expose passes
 #ifndef LLVM_TRANSFORMS_SCALAR_H
 #define LLVM_TRANSFORMS_SCALAR_H
 
+#include <cstdlib>
+
 namespace llvm {
 
-class ModulePass;
 class FunctionPass;
+class LoopPass;
+class Pass;
 class GetElementPtrInst;
 class PassInfo;
 class TerminatorInst;
+class TargetLowering;
 
 //===----------------------------------------------------------------------===//
 //
-// RaisePointerReferences - Try to eliminate as many pointer arithmetic
-// expressions as possible, by converting expressions to use getelementptr and
-// friends.
-//
-FunctionPass *createRaisePointerReferencesPass();
-
-//===----------------------------------------------------------------------===//
-//
-// Constant Propagation Pass - A worklist driven constant propagation pass
+// ConstantPropagation - A worklist driven constant propagation pass
 //
 FunctionPass *createConstantPropagationPass();
 
-
 //===----------------------------------------------------------------------===//
 //
-// Sparse Conditional Constant Propagation Pass
+// SCCP - Sparse conditional constant propagation.
 //
 FunctionPass *createSCCPPass();
 
-
 //===----------------------------------------------------------------------===//
 //
 // DeadInstElimination - This pass quickly removes trivially dead instructions
 // without modifying the CFG of the function.  It is a BasicBlockPass, so it
 // runs efficiently when queued next to other BasicBlockPass's.
 //
-FunctionPass *createDeadInstEliminationPass();
-
+Pass *createDeadInstEliminationPass();
 
 //===----------------------------------------------------------------------===//
 //
@@ -78,14 +71,12 @@ FunctionPass *createDeadStoreEliminationPass();
 //
 FunctionPass *createAggressiveDCEPass();
 
-
 //===----------------------------------------------------------------------===//
 //
-// Scalar Replacement of Aggregates - Break up alloca's of aggregates into
-// multiple allocas if possible.
+// ScalarReplAggregates - Break up alloca's of aggregates into multiple allocas
+// if possible.
 //
-FunctionPass *createScalarReplAggregatesPass();
-
+FunctionPass *createScalarReplAggregatesPass(signed Threshold = -1);
 
 //===----------------------------------------------------------------------===//
 //
@@ -96,20 +87,18 @@ FunctionPass *createScalarReplAggregatesPass();
 //
 FunctionPass *createGCSEPass();
 
-
 //===----------------------------------------------------------------------===//
 //
 // InductionVariableSimplify - Transform induction variables in a program to all
 // use a single canonical induction variable per loop.
 //
-FunctionPass *createIndVarSimplifyPass();
-
+LoopPass *createIndVarSimplifyPass();
 
 //===----------------------------------------------------------------------===//
 //
 // InstructionCombining - Combine instructions to form fewer, simple
-//   instructions.  This pass does not modify the CFG, and has a tendency to
-//   make instructions dead, so a subsequent DCE pass is useful.
+// instructions. This pass does not modify the CFG, and has a tendency to make
+// instructions dead, so a subsequent DCE pass is useful.
 //
 // This pass combines things like:
 //    %Y = add int 1, %X
@@ -119,37 +108,52 @@ FunctionPass *createIndVarSimplifyPass();
 //
 FunctionPass *createInstructionCombiningPass();
 
-
 //===----------------------------------------------------------------------===//
 //
 // LICM - This pass is a loop invariant code motion and memory promotion pass.
 //
-FunctionPass *createLICMPass();
+LoopPass *createLICMPass();
 
 //===----------------------------------------------------------------------===//
 //
 // LoopStrengthReduce - This pass is strength reduces GEP instructions that use
-// a loop's canonical induction variable as one of their indices.
+// a loop's canonical induction variable as one of their indices.  It takes an
+// optional parameter used to consult the target machine whether certain
+// transformations are profitable.
 //
-FunctionPass *createLoopStrengthReducePass();
+LoopPass *createLoopStrengthReducePass(const TargetLowering *TLI = 0);
 
 //===----------------------------------------------------------------------===//
 //
 // LoopUnswitch - This pass is a simple loop unswitching pass.
 //
-FunctionPass *createLoopUnswitchPass();
-
+LoopPass *createLoopUnswitchPass(bool OptimizeForSize = false);
 
 //===----------------------------------------------------------------------===//
 //
 // LoopUnroll - This pass is a simple loop unrolling pass.
 //
-FunctionPass *createLoopUnrollPass();
+LoopPass *createLoopUnrollPass();
+
+//===----------------------------------------------------------------------===//
+//
+// LoopRotate - This pass is a simple loop rotating pass.
+//
+LoopPass *createLoopRotatePass();
 
 //===----------------------------------------------------------------------===//
 //
-// This pass is used to promote memory references to be register references.  A
-// simple example of the transformation performed by this pass is:
+// LoopIndexSplit - This pass divides loop's iteration range by spliting loop
+// such that each individual loop is executed efficiently.
+//
+LoopPass *createLoopIndexSplitPass();
+
+
+//===----------------------------------------------------------------------===//
+//
+// PromoteMemoryToRegister - This pass is used to promote memory references to
+// be register references. A simple example of the transformation performed by
+// this pass is:
 //
 //        FROM CODE                           TO CODE
 //   %X = alloca int, uint 1                 ret int 42
@@ -157,13 +161,22 @@ FunctionPass *createLoopUnrollPass();
 //   %Y = load int* %X
 //   ret int %Y
 //
-FunctionPass *createPromoteMemoryToRegister();
+FunctionPass *createPromoteMemoryToRegisterPass();
+extern const PassInfo *PromoteMemoryToRegisterID;
 
+//===----------------------------------------------------------------------===//
+//
+// DemoteRegisterToMemoryPass - This pass is used to demote registers to memory
+// references. In basically undoes the PromoteMemoryToRegister pass to make cfg
+// hacking easier.
+//
+FunctionPass *createDemoteRegisterToMemoryPass();
+extern const PassInfo *DemoteRegisterToMemoryID;
 
 //===----------------------------------------------------------------------===//
 //
-// This pass reassociates commutative expressions in an order that is designed
-// to promote better constant propagation, GCSE, LICM, PRE...
+// Reassociate - This pass reassociates commutative expressions in an order that
+// is designed to promote better constant propagation, GCSE, LICM, PRE...
 //
 // For example:  4 + (x + 5)  ->  x + (4 + 5)
 //
@@ -171,13 +184,11 @@ FunctionPass *createReassociatePass();
 
 //===----------------------------------------------------------------------===//
 //
-// This pass eliminates correlated conditions, such as these:
-//  if (X == 0)
-//    if (X > 2) ;   // Known false
-//    else
-//      Y = X * Z;   // = 0
+// CondPropagationPass - This pass propagates information about conditional
+// expressions through the program, allowing it to eliminate conditional
+// branches in some cases.
 //
-FunctionPass *createCorrelatedExpressionEliminationPass();
+FunctionPass *createCondPropagationPass();
 
 //===----------------------------------------------------------------------===//
 //
@@ -186,20 +197,18 @@ FunctionPass *createCorrelatedExpressionEliminationPass();
 //
 FunctionPass *createTailDuplicationPass();
 
-
 //===----------------------------------------------------------------------===//
 //
-// CFG Simplification - Merge basic blocks, eliminate unreachable blocks,
+// CFGSimplification - Merge basic blocks, eliminate unreachable blocks,
 // simplify terminator instructions, etc...
 //
 FunctionPass *createCFGSimplificationPass();
 
-
 //===----------------------------------------------------------------------===//
 //
-// BreakCriticalEdges pass - Break all of the critical edges in the CFG by
-// inserting a dummy basic block.  This pass may be "required" by passes that
-// cannot deal with critical edges.  For this usage, a pass must call:
+// BreakCriticalEdges - Break all of the critical edges in the CFG by inserting
+// a dummy basic block. This pass may be "required" by passes that cannot deal
+// with critical edges. For this usage, a pass must call:
 //
 //   AU.addRequiredID(BreakCriticalEdgesID);
 //
@@ -211,9 +220,9 @@ extern const PassInfo *BreakCriticalEdgesID;
 
 //===----------------------------------------------------------------------===//
 //
-// LoopSimplify pass - Insert Pre-header blocks into the CFG for every function
-// in the module.  This pass updates dominator information, loop information,
-// and does not add critical edges to the CFG.
+// LoopSimplify - Insert Pre-header blocks into the CFG for every function in
+// the module.  This pass updates dominator information, loop information, and
+// does not add critical edges to the CFG.
 //
 //   AU.addRequiredID(LoopSimplifyID);
 //
@@ -221,68 +230,100 @@ FunctionPass *createLoopSimplifyPass();
 extern const PassInfo *LoopSimplifyID;
 
 //===----------------------------------------------------------------------===//
-// 
-// This pass eliminates call instructions to the current function which occur
-// immediately before return instructions.
 //
-FunctionPass *createTailCallEliminationPass();
-
+// LowerSelect - This pass converts SelectInst instructions into conditional
+// branch and PHI instructions. If the OnlyFP flag is set to true, then only
+// floating point select instructions are lowered.
+//
+FunctionPass *createLowerSelectPass(bool OnlyFP = false);
+extern const PassInfo *LowerSelectID;
 
 //===----------------------------------------------------------------------===//
-// This pass convert malloc and free instructions to %malloc & %free function
+//
+// LowerAllocations - Turn malloc and free instructions into %malloc and %free
 // calls.
 //
-FunctionPass *createLowerAllocationsPass();
+//   AU.addRequiredID(LowerAllocationsID);
+//
+Pass *createLowerAllocationsPass(bool LowerMallocArgToInteger = false);
+extern const PassInfo *LowerAllocationsID;
 
 //===----------------------------------------------------------------------===//
-// This pass converts SwitchInst instructions into a sequence of chained binary
-// branch instructions.
 //
-FunctionPass *createLowerSwitchPass();
+// TailCallElimination - This pass eliminates call instructions to the current
+// function which occur immediately before return instructions.
+//
+FunctionPass *createTailCallEliminationPass();
 
 //===----------------------------------------------------------------------===//
-// This pass converts SelectInst instructions into conditional branch and PHI
-// instructions.  If the OnlyFP flag is set to true, then only floating point
-// select instructions are lowered.
 //
-FunctionPass *createLowerSelectPass(bool OnlyFP = false);
+// LowerSwitch - This pass converts SwitchInst instructions into a sequence of
+// chained binary branch instructions.
+//
+FunctionPass *createLowerSwitchPass();
+extern const PassInfo *LowerSwitchID;
 
 //===----------------------------------------------------------------------===//
-// This pass converts PackedType operations into low-level scalar operations.
+//
+// LowerPacked - This pass converts VectorType operations into low-level scalar
+// operations.
 //
 FunctionPass *createLowerPackedPass();
 
 //===----------------------------------------------------------------------===//
-// This pass converts invoke and unwind instructions to use sjlj exception
-// handling mechanisms.  Note that after this pass runs the CFG is not entirely
-// accurate (exceptional control flow edges are not correct anymore) so only
-// very simple things should be done after the lowerinvoke pass has run (like
-// generation of native code).  This should *NOT* be used as a general purpose
-// "my LLVM-to-LLVM pass doesn't support the invoke instruction yet" lowering
-// pass.
 //
-FunctionPass *createLowerInvokePass();
+// LowerInvoke - This pass converts invoke and unwind instructions to use sjlj
+// exception handling mechanisms.  Note that after this pass runs the CFG is not
+// entirely accurate (exceptional control flow edges are not correct anymore) so
+// only very simple things should be done after the lowerinvoke pass has run
+// (like generation of native code).  This should *NOT* be used as a general
+// purpose "my LLVM-to-LLVM pass doesn't support the invoke instruction yet"
+// lowering pass.
+//
+FunctionPass *createLowerInvokePass(const TargetLowering *TLI = NULL);
 extern const PassInfo *LowerInvokePassID;
 
-  
 //===----------------------------------------------------------------------===//
-/// createLowerGCPass - This function returns an instance of the "lowergc"
-/// pass, which lowers garbage collection intrinsics to normal LLVM code.
-///
-FunctionPass *createLowerGCPass();
+//
+// BlockPlacement - This pass reorders basic blocks in order to increase the
+// number of fall-through conditional branches.
+//
+FunctionPass *createBlockPlacementPass();
+
+//===----------------------------------------------------------------------===//
+//
+// LCSSA - This pass inserts phi nodes at loop boundaries to simplify other loop
+// optimizations.
+//
+LoopPass *createLCSSAPass();
+extern const PassInfo *LCSSAID;
 
 //===----------------------------------------------------------------------===//
-// Returns a pass which converts all instances of ConstantExpression
-// into regular LLVM instructions.
-FunctionPass* createLowerConstantExpressionsPass();
-  
+//
+// PredicateSimplifier - This pass collapses duplicate variables into one
+// canonical form, and tries to simplify expressions along the way.
+//
+FunctionPass *createPredicateSimplifierPass();
+
+//===----------------------------------------------------------------------===//
+//
+// GVN-PRE - This pass performs global value numbering and partial redundancy
+// elimination.
+//
+FunctionPass *createGVNPREPass();
+
+//===----------------------------------------------------------------------===//
+//
+// GVN - This pass performs global value numbering and redundant load 
+// elimination cotemporaneously.
+//
+FunctionPass *createGVNPass();
 
 //===----------------------------------------------------------------------===//
 //
-// These functions removes symbols from functions and modules.
+// CodeGenPrepare - This pass prepares a function for instruction selection.
 //
-FunctionPass *createSymbolStrippingPass();
-FunctionPass *createFullSymbolStrippingPass();
+FunctionPass *createCodeGenPreparePass(const TargetLowering *TLI = 0);
 
 } // End llvm namespace