Remove trailing whitespace
[oota-llvm.git] / include / llvm / Transforms / Scalar.h
index a950b1b6245177e62e50f2cd76864fd6b4c51967..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();
 
 
 //===----------------------------------------------------------------------===//
@@ -68,7 +68,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 +76,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 +84,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 +102,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 +126,15 @@ 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.  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.
+//
+FunctionPass *createLoopStrengthReducePass(unsigned MaxTargetAMSize = 1);
 
 //===----------------------------------------------------------------------===//
 //
@@ -155,7 +149,6 @@ FunctionPass *createLoopUnswitchPass();
 //
 FunctionPass *createLoopUnrollPass();
 
-
 //===----------------------------------------------------------------------===//
 //
 // This pass is used to promote memory references to be register references.  A
@@ -167,7 +160,7 @@ FunctionPass *createLoopUnrollPass();
 //   %Y = load int* %X
 //   ret int %Y
 //
-Pass *createPromoteMemoryToRegister();
+FunctionPass *createPromoteMemoryToRegisterPass();
 
 
 //===----------------------------------------------------------------------===//
@@ -187,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();
 
 
 //===----------------------------------------------------------------------===//
@@ -227,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.
 //
@@ -242,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
@@ -257,6 +257,11 @@ FunctionPass *createLowerSwitchPass();
 //
 FunctionPass *createLowerSelectPass(bool OnlyFP = false);
 
+//===----------------------------------------------------------------------===//
+// 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
@@ -269,7 +274,7 @@ FunctionPass *createLowerSelectPass(bool OnlyFP = false);
 FunctionPass *createLowerInvokePass();
 extern const PassInfo *LowerInvokePassID;
 
-  
+
 //===----------------------------------------------------------------------===//
 /// createLowerGCPass - This function returns an instance of the "lowergc"
 /// pass, which lowers garbage collection intrinsics to normal LLVM code.
@@ -280,14 +285,15 @@ FunctionPass *createLowerGCPass();
 // Returns a pass which converts all instances of ConstantExpression
 // into regular LLVM instructions.
 FunctionPass* createLowerConstantExpressionsPass();
-  
 
 //===----------------------------------------------------------------------===//
-//
-// These functions removes symbols from functions and modules.
-//
-Pass *createSymbolStrippingPass();
-Pass *createFullSymbolStrippingPass();
+// 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