-//===-- Scalar.h - Scalar Transformations ------------------------*- C++ -*-==//
+//===-- Scalar.h - Scalar Transformations -----------------------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// 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
// in the Scalar transformations library.
#ifndef LLVM_TRANSFORMS_SCALAR_H
#define LLVM_TRANSFORMS_SCALAR_H
+#include <cstdlib>
+
+namespace llvm {
+
+class FunctionPass;
+class LoopPass;
class Pass;
-class TargetData;
-class BasicBlock;
class GetElementPtrInst;
+class PassInfo;
+class TerminatorInst;
+class TargetLowering;
//===----------------------------------------------------------------------===//
//
-// Constant Propogation Pass - A worklist driven constant propogation pass
+// ConstantPropagation - A worklist driven constant propagation pass
//
-Pass *createConstantPropogationPass();
-
+FunctionPass *createConstantPropagationPass();
//===----------------------------------------------------------------------===//
//
-// Sparse Conditional Constant Propogation Pass
+// SCCP - Sparse conditional constant propagation.
//
-Pass *createSCCPPass();
-
+FunctionPass *createSCCPPass();
//===----------------------------------------------------------------------===//
//
//
Pass *createDeadInstEliminationPass();
-
//===----------------------------------------------------------------------===//
//
// DeadCodeElimination - This pass is more powerful than DeadInstElimination,
// 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();
//===----------------------------------------------------------------------===//
//
// algorithm assumes instructions are dead until proven otherwise, which makes
// it more successful are removing non-obviously dead instructions.
//
-Pass *createAggressiveDCEPass();
-
+FunctionPass *createAggressiveDCEPass();
//===----------------------------------------------------------------------===//
-//
-// 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.
-Pass *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);
+//
+// ScalarReplAggregates - Break up alloca's of aggregates into multiple allocas
+// if possible.
+//
+FunctionPass *createScalarReplAggregatesPass(signed Threshold = -1);
//===----------------------------------------------------------------------===//
//
// examining the SSA value graph of the function, instead of doing slow
// bit-vector computations.
//
-Pass *createGCSEPass();
-
+FunctionPass *createGCSEPass();
//===----------------------------------------------------------------------===//
//
// InductionVariableSimplify - Transform induction variables in a program to all
-// use a single cannonical induction variable per loop.
+// 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 tendancy 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
// into:
// %Z = add int 2, %X
//
-Pass *createInstructionCombiningPass();
+FunctionPass *createInstructionCombiningPass();
+//===----------------------------------------------------------------------===//
+//
+// LICM - This pass is a loop invariant code motion and memory promotion pass.
+//
+LoopPass *createLICMPass();
//===----------------------------------------------------------------------===//
//
-// LICM - This pass is a simple natural loop based loop invariant code motion
-// pass.
+// 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.
//
-Pass *createLICMPass();
+LoopPass *createLoopStrengthReducePass(const TargetLowering *TLI = 0);
+//===----------------------------------------------------------------------===//
+//
+// LoopUnswitch - This pass is a simple loop unswitching pass.
+//
+LoopPass *createLoopUnswitchPass(bool OptimizeForSize = false);
//===----------------------------------------------------------------------===//
//
-// 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;
+// LoopUnroll - This pass is a simple loop unrolling 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 *createLoopUnrollPass();
+
+//===----------------------------------------------------------------------===//
//
-// 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.
+// LoopRotate - This pass is a simple loop rotating pass.
//
-Pass *createPiNodeInsertionPass();
+LoopPass *createLoopRotatePass();
+
+//===----------------------------------------------------------------------===//
+//
+// LoopIndexSplit - This pass divides loop's iteration range by spliting loop
+// such that each individual loop is executed efficiently.
+//
+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
// %Y = load int* %X
// ret int %Y
//
-Pass *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 propogation, 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)
//
-Pass *createReassociatePass();
+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();
//===----------------------------------------------------------------------===//
//
-// CFG Simplification - Merge basic blocks, eliminate unreachable blocks,
+// TailDuplication - Eliminate unconditional branches through controlled code
+// duplication, creating simpler CFG structures.
+//
+FunctionPass *createTailDuplicationPass();
+
+//===----------------------------------------------------------------------===//
+//
+// CFGSimplification - Merge basic blocks, eliminate unreachable blocks,
// simplify terminator instructions, etc...
//
-Pass *createCFGSimplificationPass();
+FunctionPass *createCFGSimplificationPass();
+
+//===----------------------------------------------------------------------===//
+//
+// 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.
+//
+FunctionPass *createBreakCriticalEdgesPass();
+extern const PassInfo *BreakCriticalEdgesID;
+
+//===----------------------------------------------------------------------===//
+//
+// 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);
+//
+FunctionPass *createLoopSimplifyPass();
+extern const PassInfo *LoopSimplifyID;
+//===----------------------------------------------------------------------===//
+//
+// 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;
//===----------------------------------------------------------------------===//
-// These two passes convert malloc and free instructions to and from %malloc &
-// %free function calls. The LowerAllocations transformation is a target
-// dependant tranformation because it depends on the size of data types and
-// alignment constraints.
//
-Pass *createLowerAllocationsPass(const TargetData &TD);
-Pass *createRaiseAllocationsPass();
+// LowerAllocations - Turn malloc and free instructions into %malloc and %free
+// calls.
+//
+// AU.addRequiredID(LowerAllocationsID);
+//
+Pass *createLowerAllocationsPass(bool LowerMallocArgToInteger = false);
+extern const PassInfo *LowerAllocationsID;
+//===----------------------------------------------------------------------===//
+//
+// TailCallElimination - This pass eliminates call instructions to the current
+// function which occur immediately before return instructions.
+//
+FunctionPass *createTailCallEliminationPass();
//===----------------------------------------------------------------------===//
//
-// These functions removes symbols from functions and modules.
+// LowerSwitch - This pass converts SwitchInst instructions into a sequence of
+// chained binary branch instructions.
+//
+FunctionPass *createLowerSwitchPass();
+extern const PassInfo *LowerSwitchID;
+
+//===----------------------------------------------------------------------===//
+//
+// LowerPacked - This pass converts VectorType operations into low-level scalar
+// operations.
+//
+FunctionPass *createLowerPackedPass();
+
+//===----------------------------------------------------------------------===//
+//
+// 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;
+
+//===----------------------------------------------------------------------===//
//
-Pass *createSymbolStrippingPass();
-Pass *createFullSymbolStrippingPass();
+// 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;
+
+//===----------------------------------------------------------------------===//
+//
+// 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();
+
+//===----------------------------------------------------------------------===//
+//
+// CodeGenPrepare - This pass prepares a function for instruction selection.
+//
+FunctionPass *createCodeGenPreparePass(const TargetLowering *TLI = 0);
+
+} // End llvm namespace
#endif
projects / oota-llvm.git / blobdiff