X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FTransforms%2FScalar.h;h=b4c3e7caf5b644273d8d17b5c8cea6a433c11c92;hb=5eca075b74d62c621b160aa216b4cd50829a2cc7;hp=db84f7cb609d9b64e853f4e389a0db7bb61e83f1;hpb=8277567dc6c7247956726c8ebdbd0547b0d72e56;p=oota-llvm.git diff --git a/include/llvm/Transforms/Scalar.h b/include/llvm/Transforms/Scalar.h index db84f7cb609..b4c3e7caf5b 100644 --- a/include/llvm/Transforms/Scalar.h +++ b/include/llvm/Transforms/Scalar.h @@ -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 @@ -17,33 +17,25 @@ namespace llvm { -class Pass; 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. -// -Pass *createRaisePointerReferencesPass(); - -//===----------------------------------------------------------------------===// -// -// Constant Propagation Pass - A worklist driven constant propagation pass +// ConstantPropagation - A worklist driven constant propagation pass // -Pass *createConstantPropagationPass(); - +FunctionPass *createConstantPropagationPass(); //===----------------------------------------------------------------------===// // -// Sparse Conditional Constant Propagation Pass +// SCCP - Sparse conditional constant propagation. // -Pass *createSCCPPass(); - +FunctionPass *createSCCPPass(); //===----------------------------------------------------------------------===// // @@ -53,7 +45,6 @@ Pass *createSCCPPass(); // Pass *createDeadInstEliminationPass(); - //===----------------------------------------------------------------------===// // // DeadCodeElimination - This pass is more powerful than DeadInstElimination, @@ -61,64 +52,42 @@ Pass *createDeadInstEliminationPass(); // their other instructions become dead, to eliminate chains of dead // computations. // -Pass *createDeadCodeEliminationPass(); - +FunctionPass *createDeadCodeEliminationPass(); //===----------------------------------------------------------------------===// // -// AggressiveDCE - This pass uses the SSA based Aggressive DCE algorithm. This -// algorithm assumes instructions are dead until proven otherwise, which makes -// it more successful are removing non-obviously dead instructions. +// DeadStoreElimination - This pass deletes stores that are post-dominated by +// must-aliased stores and are not loaded used between the stores. // -Pass *createAggressiveDCEPass(); - +FunctionPass *createDeadStoreEliminationPass(); //===----------------------------------------------------------------------===// // -// Scalar Replacement of Aggregates - Break up alloca's of aggregates into -// multiple allocas if possible. +// AggressiveDCE - This pass uses the SSA based Aggressive DCE algorithm. This +// algorithm assumes instructions are dead until proven otherwise, which makes +// it more successful are removing non-obviously dead instructions. // -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(); - -// This function decomposes a single instance of such a reference. -// Return value: true if the instruction was replaced; false otherwise. -// -bool DecomposeArrayRef(GetElementPtrInst* GEP); +FunctionPass *createAggressiveDCEPass(); //===----------------------------------------------------------------------===// // -// GCSE - This pass is designed to be a very quick global transformation that -// eliminates global common subexpressions from a function. It does this by -// examining the SSA value graph of the function, instead of doing slow -// bit-vector computations. +// ScalarReplAggregates - Break up alloca's of aggregates into multiple allocas +// if possible. // -FunctionPass *createGCSEPass(); - +FunctionPass *createScalarReplAggregatesPass(signed Threshold = -1); //===----------------------------------------------------------------------===// // // InductionVariableSimplify - Transform induction variables in a program to all // use a single canonical induction variable per loop. // -Pass *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 @@ -126,57 +95,54 @@ Pass *createIndVarSimplifyPass(); // into: // %Z = add int 2, %X // -Pass *createInstructionCombiningPass(); - +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. It takes an +// optional parameter used to consult the target machine whether certain +// transformations are profitable. +// +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(); //===----------------------------------------------------------------------===// // -// 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; +// LoopRotate - This pass is a simple loop rotating pass. // -// 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". +LoopPass *createLoopRotatePass(); + +//===----------------------------------------------------------------------===// // -// 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. +// LoopIndexSplit - This pass divides loop's iteration range by spliting loop +// such that each individual loop is executed efficiently. // -Pass *createPiNodeInsertionPass(); +LoopPass *createLoopIndexSplitPass(); //===----------------------------------------------------------------------===// // -// This pass is used to promote memory references to be register references. A -// simple example of the transformation performed by this pass is: +// 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 @@ -184,13 +150,22 @@ Pass *createPiNodeInsertionPass(); // %Y = load int* %X // ret int %Y // -Pass *createPromoteMemoryToRegister(); +FunctionPass *createPromoteMemoryToRegisterPass(); +extern const PassInfo *const 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 *const 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) // @@ -198,99 +173,157 @@ 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. // -Pass *createCorrelatedExpressionEliminationPass(); +FunctionPass *createCondPropagationPass(); //===----------------------------------------------------------------------===// // // TailDuplication - Eliminate unconditional branches through controlled code // duplication, creating simpler CFG structures. // -Pass *createTailDuplicationPass(); - +FunctionPass *createTailDuplicationPass(); //===----------------------------------------------------------------------===// // -// CFG Simplification - Merge basic blocks, eliminate unreachable blocks, +// JumpThreading - Thread control through mult-pred/multi-succ blocks where some +// preds always go to some succ. +// +FunctionPass *createJumpThreadingPass(); + +//===----------------------------------------------------------------------===// +// +// 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); // // This pass obviously invalidates the CFG, but can update forward dominator // (set, immediate dominators, tree, and frontier) information. // -Pass *createBreakCriticalEdgesPass(); -extern const PassInfo *BreakCriticalEdgesID; +FunctionPass *createBreakCriticalEdgesPass(); +extern const PassInfo *const 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); // -Pass *createLoopSimplifyPass(); -extern const PassInfo *LoopSimplifyID; +FunctionPass *createLoopSimplifyPass(); +extern const PassInfo *const LoopSimplifyID; + +//===----------------------------------------------------------------------===// +// +// LowerAllocations - Turn malloc and free instructions into %malloc and %free +// calls. +// +// AU.addRequiredID(LowerAllocationsID); +// +Pass *createLowerAllocationsPass(bool LowerMallocArgToInteger = false); +extern const PassInfo *const LowerAllocationsID; //===----------------------------------------------------------------------===// -// -// This pass eliminates call instructions to the current function which occur -// immediately before return instructions. +// +// TailCallElimination - This pass eliminates call instructions to the current +// function which occur immediately before return instructions. // FunctionPass *createTailCallEliminationPass(); +//===----------------------------------------------------------------------===// +// +// LowerSwitch - This pass converts SwitchInst instructions into a sequence of +// chained binary branch instructions. +// +FunctionPass *createLowerSwitchPass(); +extern const PassInfo *const LowerSwitchID; //===----------------------------------------------------------------------===// -// This pass convert malloc and free instructions to %malloc & %free function -// calls. // -FunctionPass *createLowerAllocationsPass(); +// 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 = 0); +extern const PassInfo *const LowerInvokePassID; //===----------------------------------------------------------------------===// -// This pass converts SwitchInst instructions into a sequence of chained binary -// branch instructions. // -FunctionPass *createLowerSwitchPass(); +// 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 *const LCSSAID; + +//===----------------------------------------------------------------------===// +// +// PredicateSimplifier - This pass collapses duplicate variables into one +// canonical form, and tries to simplify expressions along the way. +// +FunctionPass *createPredicateSimplifierPass(); //===----------------------------------------------------------------------===// -// 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); +// GVN-PRE - This pass performs global value numbering and partial redundancy +// elimination. +// +FunctionPass *createGVNPREPass(); //===----------------------------------------------------------------------===// -// 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; +// GVN - This pass performs global value numbering and redundant load +// elimination cotemporaneously. +// +FunctionPass *createGVNPass(); + +//===----------------------------------------------------------------------===// +// +// MemCpyOpt - This pass performs optimizations related to eliminating memcpy +// calls and/or combining multiple stores into memset's. +// +FunctionPass *createMemCpyOptPass(); + +//===----------------------------------------------------------------------===// +// +// LoopDeletion - This pass performs DCE of non-infinite loops that it +// can prove are dead. +// +LoopPass *createLoopDeletionPass(); + +//===----------------------------------------------------------------------===// +// +/// createSimplifyLibCallsPass - This pass optimizes specific calls to +/// specific well-known (library) functions. +FunctionPass *createSimplifyLibCallsPass(); //===----------------------------------------------------------------------===// // -// These functions removes symbols from functions and modules. +// CodeGenPrepare - This pass prepares a function for instruction selection. // -Pass *createSymbolStrippingPass(); -Pass *createFullSymbolStrippingPass(); +FunctionPass *createCodeGenPreparePass(const TargetLowering *TLI = 0); } // End llvm namespace