Remove trailing whitespace
[oota-llvm.git] / include / llvm / Transforms / Scalar.h
index b50d1884ce79aac3695f4416803c51726ca82895..4cc59dd3c7545192b5686e82d87101ea47c705f2 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
@@ -17,7 +17,7 @@
 
 namespace llvm {
 
-class Pass;
+class ModulePass;
 class FunctionPass;
 class GetElementPtrInst;
 class PassInfo;
@@ -29,20 +29,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 +51,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();
 
 
 //===----------------------------------------------------------------------===//
@@ -61,8 +61,14 @@ Pass *createDeadInstEliminationPass();
 // their other instructions become dead, to eliminate chains of dead
 // computations.
 //
-Pass *createDeadCodeEliminationPass();
+FunctionPass *createDeadCodeEliminationPass();
 
+//===----------------------------------------------------------------------===//
+//
+// DeadStoreElimination - This pass deletes stores that are post-dominated by
+// must-aliased stores and are not loaded used between the stores.
+//
+FunctionPass *createDeadStoreEliminationPass();
 
 //===----------------------------------------------------------------------===//
 //
@@ -70,7 +76,7 @@ Pass *createDeadCodeEliminationPass();
 // algorithm assumes instructions are dead until proven otherwise, which makes
 // it more successful are removing non-obviously dead instructions.
 //
-Pass *createAggressiveDCEPass();
+FunctionPass *createAggressiveDCEPass();
 
 
 //===----------------------------------------------------------------------===//
@@ -78,23 +84,8 @@ Pass *createAggressiveDCEPass();
 // Scalar Replacement of Aggregates - Break up alloca's of aggregates into
 // multiple allocas if possible.
 //
-Pass *createScalarReplAggregatesPass();
+FunctionPass *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();
-
-// This function decomposes a single instance of such a reference.
-// Return value: true if the instruction was replaced; false otherwise.
-// 
-bool DecomposeArrayRef(GetElementPtrInst* GEP);
 
 //===----------------------------------------------------------------------===//
 //
@@ -111,13 +102,13 @@ FunctionPass *createGCSEPass();
 // InductionVariableSimplify - Transform induction variables in a program to all
 // use a single canonical induction variable per loop.
 //
-Pass *createIndVarSimplifyPass();
+FunctionPass *createIndVarSimplifyPass();
 
 
 //===----------------------------------------------------------------------===//
 //
 // InstructionCombining - Combine instructions to form fewer, simple
-//   instructions.  This pass does not modify the CFG, and has a tendancy to
+//   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:
@@ -126,40 +117,38 @@ Pass *createIndVarSimplifyPass();
 // into:
 //    %Z = add int 2, %X
 //
-Pass *createInstructionCombiningPass();
+FunctionPass *createInstructionCombiningPass();
 
 
 //===----------------------------------------------------------------------===//
 //
-// LICM - This pass is a simple natural loop based loop invariant code motion
-// pass.
+// LICM - This pass is a loop invariant code motion and memory promotion pass.
 //
 FunctionPass *createLICMPass();
 
-
 //===----------------------------------------------------------------------===//
 //
-// 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;
+// LoopStrengthReduce - This pass is strength reduces GEP instructions that use
+// a loop's canonical induction variable as one of their indices.  The
+// MaxTargetAMSize is the largest element size that the target architecture
+// can handle in its addressing modes.  Power of two multipliers less than or
+// equal to this value are not reduced.
 //
-// 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".
+FunctionPass *createLoopStrengthReducePass(unsigned MaxTargetAMSize = 1);
+
+//===----------------------------------------------------------------------===//
 //
-// 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.
+// LoopUnswitch - This pass is a simple loop unswitching pass.
 //
-Pass *createPiNodeInsertionPass();
+FunctionPass *createLoopUnswitchPass();
 
 
+//===----------------------------------------------------------------------===//
+//
+// LoopUnroll - This pass is a simple loop unrolling pass.
+//
+FunctionPass *createLoopUnrollPass();
+
 //===----------------------------------------------------------------------===//
 //
 // This pass is used to promote memory references to be register references.  A
@@ -171,7 +160,7 @@ Pass *createPiNodeInsertionPass();
 //   %Y = load int* %X
 //   ret int %Y
 //
-Pass *createPromoteMemoryToRegister();
+FunctionPass *createPromoteMemoryToRegisterPass();
 
 
 //===----------------------------------------------------------------------===//
@@ -191,14 +180,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();
 
 
 //===----------------------------------------------------------------------===//
@@ -220,7 +216,7 @@ FunctionPass *createCFGSimplificationPass();
 // This pass obviously invalidates the CFG, but can update forward dominator
 // (set, immediate dominators, tree, and frontier) information.
 //
-Pass *createBreakCriticalEdgesPass();
+FunctionPass *createBreakCriticalEdgesPass();
 extern const PassInfo *BreakCriticalEdgesID;
 
 //===----------------------------------------------------------------------===//
@@ -231,11 +227,11 @@ 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.
 //
@@ -246,7 +242,7 @@ FunctionPass *createTailCallEliminationPass();
 // This pass convert malloc and free instructions to %malloc & %free function
 // calls.
 //
-FunctionPass *createLowerAllocationsPass();
+FunctionPass *createLowerAllocationsPass(bool LowerMallocArgToInteger = false);
 
 //===----------------------------------------------------------------------===//
 // This pass converts SwitchInst instructions into a sequence of chained binary
@@ -254,20 +250,50 @@ FunctionPass *createLowerAllocationsPass();
 //
 FunctionPass *createLowerSwitchPass();
 
+//===----------------------------------------------------------------------===//
+// 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);
 
 //===----------------------------------------------------------------------===//
-// This pass converts 'invoke' instructions calls, and 'unwind' instructions
-// into calls to abort().
+// This pass converts PackedType 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();
 extern const PassInfo *LowerInvokePassID;
 
+
 //===----------------------------------------------------------------------===//
-//
-// These functions removes symbols from functions and modules.
-//
-Pass *createSymbolStrippingPass();
-Pass *createFullSymbolStrippingPass();
+/// createLowerGCPass - This function returns an instance of the "lowergc"
+/// pass, which lowers garbage collection intrinsics to normal LLVM code.
+///
+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();
+
+//===----------------------------------------------------------------------===//
+// This pass does partial redundancy elimination.
+FunctionPass *createPREPass();
 
 } // End llvm namespace