Skeletal LCSSA pass. This is currently non-functional. Expect functionality
[oota-llvm.git] / include / llvm / Transforms / Scalar.h
index 4db4ab7da117d2c8a7e1bce4fb7a410164b0a3d0..111ced11d64b6f80d749c461bcd381d5a4b208a5 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 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 Pass;
+class ModulePass;
 class FunctionPass;
 class GetElementPtrInst;
 class PassInfo;
 class TerminatorInst;
+class TargetLowering;
 
 //===----------------------------------------------------------------------===//
 //
@@ -29,20 +32,20 @@ class TerminatorInst;
 // expressions as possible, by converting expressions to use getelementptr and
 // friends.
 //
-Pass *createRaisePointerReferencesPass();
+FunctionPass *createRaisePointerReferencesPass();
 
 //===----------------------------------------------------------------------===//
 //
 // Constant Propagation Pass - A worklist driven constant propagation pass
 //
-Pass *createConstantPropagationPass();
+FunctionPass *createConstantPropagationPass();
 
 
 //===----------------------------------------------------------------------===//
 //
 // Sparse Conditional Constant Propagation Pass
 //
-Pass *createSCCPPass();
+FunctionPass *createSCCPPass();
 
 
 //===----------------------------------------------------------------------===//
@@ -51,7 +54,7 @@ Pass *createSCCPPass();
 // without modifying the CFG of the function.  It is a BasicBlockPass, so it
 // runs efficiently when queued next to other BasicBlockPass's.
 //
-Pass *createDeadInstEliminationPass();
+FunctionPass *createDeadInstEliminationPass();
 
 
 //===----------------------------------------------------------------------===//
@@ -68,7 +71,7 @@ FunctionPass *createDeadCodeEliminationPass();
 // DeadStoreElimination - This pass deletes stores that are post-dominated by
 // must-aliased stores and are not loaded used between the stores.
 //
-Pass *createDeadStoreEliminationPass();
+FunctionPass *createDeadStoreEliminationPass();
 
 //===----------------------------------------------------------------------===//
 //
@@ -76,7 +79,7 @@ Pass *createDeadStoreEliminationPass();
 // algorithm assumes instructions are dead until proven otherwise, which makes
 // it more successful are removing non-obviously dead instructions.
 //
-Pass *createAggressiveDCEPass();
+FunctionPass *createAggressiveDCEPass();
 
 
 //===----------------------------------------------------------------------===//
@@ -84,23 +87,8 @@ Pass *createAggressiveDCEPass();
 // Scalar Replacement of Aggregates - Break up alloca's of aggregates into
 // multiple allocas if possible.
 //
-Pass *createScalarReplAggregatesPass();
-
-//===----------------------------------------------------------------------===//
-// 
-// DecomposeMultiDimRefs - Convert multi-dimensional references consisting of
-// any combination of 2 or more array and structure indices into a sequence of
-// instructions (using getelementpr and cast) so that each instruction has at
-// most one index (except structure references, which need an extra leading
-// index of [0]).
-
-// This pass decomposes all multi-dimensional references in a function.
-FunctionPass *createDecomposeMultiDimRefsPass();
+FunctionPass *createScalarReplAggregatesPass();
 
-// This function decomposes a single instance of such a reference.
-// Return value: true if the instruction was replaced; false otherwise.
-// 
-bool DecomposeArrayRef(GetElementPtrInst* GEP);
 
 //===----------------------------------------------------------------------===//
 //
@@ -117,7 +105,7 @@ FunctionPass *createGCSEPass();
 // InductionVariableSimplify - Transform induction variables in a program to all
 // use a single canonical induction variable per loop.
 //
-Pass *createIndVarSimplifyPass();
+FunctionPass *createIndVarSimplifyPass();
 
 
 //===----------------------------------------------------------------------===//
@@ -141,6 +129,14 @@ FunctionPass *createInstructionCombiningPass();
 //
 FunctionPass *createLICMPass();
 
+//===----------------------------------------------------------------------===//
+//
+// LoopStrengthReduce - This pass is strength reduces GEP instructions that use
+// 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(const TargetLowering *TLI = NULL);
 
 //===----------------------------------------------------------------------===//
 //
@@ -155,30 +151,6 @@ FunctionPass *createLoopUnswitchPass();
 //
 FunctionPass *createLoopUnrollPass();
 
-
-//===----------------------------------------------------------------------===//
-//
-// PiNodeInsertion - This pass inserts single entry Phi nodes into basic blocks
-// that are preceeded by a conditional branch, where the branch gives
-// information about the operands of the condition.  For example, this C code:
-//   if (x == 0) { ... = x + 4;
-// becomes:
-//   if (x == 0) {
-//     x2 = phi(x);    // Node that can hold data flow information about X
-//     ... = x2 + 4;
-//
-// Since the direction of the condition branch gives information about X itself
-// (whether or not it is zero), some passes (like value numbering or ABCD) can
-// use the inserted Phi/Pi nodes as a place to attach information, in this case
-// saying that X has a value of 0 in this scope.  The power of this analysis
-// information is that "in the scope" translates to "for all uses of x2".
-//
-// This special form of Phi node is refered to as a Pi node, following the
-// terminology defined in the "Array Bounds Checks on Demand" paper.
-//
-Pass *createPiNodeInsertionPass();
-
-
 //===----------------------------------------------------------------------===//
 //
 // This pass is used to promote memory references to be register references.  A
@@ -190,8 +162,16 @@ Pass *createPiNodeInsertionPass();
 //   %Y = load int* %X
 //   ret int %Y
 //
-Pass *createPromoteMemoryToRegister();
+FunctionPass *createPromoteMemoryToRegisterPass();
+extern const PassInfo *PromoteMemoryToRegisterID;
 
+//===----------------------------------------------------------------------===//
+//
+// 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;
 
 //===----------------------------------------------------------------------===//
 //
@@ -210,14 +190,21 @@ FunctionPass *createReassociatePass();
 //    else
 //      Y = X * Z;   // = 0
 //
-Pass *createCorrelatedExpressionEliminationPass();
+FunctionPass *createCorrelatedExpressionEliminationPass();
+
+
+// createCondPropagationPass - This pass propagates information about
+// conditional expressions through the program, allowing it to eliminate
+// conditional branches in some cases.
+//
+FunctionPass *createCondPropagationPass();
 
 //===----------------------------------------------------------------------===//
 //
 // TailDuplication - Eliminate unconditional branches through controlled code
 // duplication, creating simpler CFG structures.
 //
-Pass *createTailDuplicationPass();
+FunctionPass *createTailDuplicationPass();
 
 
 //===----------------------------------------------------------------------===//
@@ -250,35 +237,45 @@ extern const PassInfo *BreakCriticalEdgesID;
 //
 //   AU.addRequiredID(LoopSimplifyID);
 //
-Pass *createLoopSimplifyPass();
+FunctionPass *createLoopSimplifyPass();
 extern const PassInfo *LoopSimplifyID;
 
 //===----------------------------------------------------------------------===//
-// 
-// This pass eliminates call instructions to the current function which occur
-// immediately before return instructions.
+// 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 *createTailCallEliminationPass();
+FunctionPass *createLowerSelectPass(bool OnlyFP = false);
+extern const PassInfo *LowerSelectID;
 
+//===----------------------------------------------------------------------===//
+//
+// LowerAllocations Pass - Turn malloc and free instructions into %malloc and
+// %free calls.
+//
+//   AU.addRequiredID(LowerAllocationsID);
+//
+FunctionPass *createLowerAllocationsPass(bool LowerMallocArgToInteger = false);
+extern const PassInfo *LowerAllocationsID;
 
 //===----------------------------------------------------------------------===//
-// This pass convert malloc and free instructions to %malloc & %free function
-// calls.
 //
-FunctionPass *createLowerAllocationsPass();
+// This pass eliminates call instructions to the current function which occur
+// immediately before return instructions.
+//
+FunctionPass *createTailCallEliminationPass();
 
 //===----------------------------------------------------------------------===//
 // This pass converts SwitchInst instructions into a sequence of chained binary
 // branch instructions.
 //
 FunctionPass *createLowerSwitchPass();
+extern const PassInfo *LowerSwitchID;
 
 //===----------------------------------------------------------------------===//
-// 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.
+// This pass converts PackedType operations into low-level scalar operations.
 //
-FunctionPass *createLowerSelectPass(bool OnlyFP = false);
+FunctionPass *createLowerPackedPass();
 
 //===----------------------------------------------------------------------===//
 // This pass converts invoke and unwind instructions to use sjlj exception
@@ -289,10 +286,11 @@ FunctionPass *createLowerSelectPass(bool OnlyFP = false);
 // "my LLVM-to-LLVM pass doesn't support the invoke instruction yet" lowering
 // pass.
 //
-FunctionPass *createLowerInvokePass();
+FunctionPass *createLowerInvokePass(unsigned JumBufSize = 200, 
+                                    unsigned JumpBufAlign = 0);
 extern const PassInfo *LowerInvokePassID;
 
-  
+
 //===----------------------------------------------------------------------===//
 /// createLowerGCPass - This function returns an instance of the "lowergc"
 /// pass, which lowers garbage collection intrinsics to normal LLVM code.
@@ -300,17 +298,14 @@ extern const PassInfo *LowerInvokePassID;
 FunctionPass *createLowerGCPass();
 
 //===----------------------------------------------------------------------===//
-// Returns a pass which converts all instances of ConstantExpression
-// into regular LLVM instructions.
-FunctionPass* createLowerConstantExpressionsPass();
-  
+// This pass reorders basic blocks in order to increase the number of fall-
+// through conditional branches.
+FunctionPass *createBlockPlacementPass();
 
 //===----------------------------------------------------------------------===//
-//
-// These functions removes symbols from functions and modules.
-//
-Pass *createSymbolStrippingPass();
-Pass *createFullSymbolStrippingPass();
+// This pass inserts phi nodes at loop boundaries to simplify other loop 
+// optimizations.
+FunctionPass *createLCSSAPass();
 
 } // End llvm namespace