2003-09-30 18:37:50 +00:00
|
|
|
//===-- Scalar.h - Scalar Transformations -----------------------*- C++ -*-===//
|
2005-04-21 20:59:05 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
// 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.
|
2005-04-21 20:59:05 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-05-07 19:37:18 +00:00
|
|
|
//
|
|
|
|
// 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
|
|
|
|
|
2006-03-13 23:14:23 +00:00
|
|
|
#include <cstdlib>
|
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
namespace llvm {
|
|
|
|
|
2004-09-20 04:41:39 +00:00
|
|
|
class ModulePass;
|
2003-08-13 18:18:15 +00:00
|
|
|
class FunctionPass;
|
2002-09-16 16:07:19 +00:00
|
|
|
class GetElementPtrInst;
|
2002-09-24 15:42:27 +00:00
|
|
|
class PassInfo;
|
2002-10-08 21:06:27 +00:00
|
|
|
class TerminatorInst;
|
2006-03-13 23:14:23 +00:00
|
|
|
class TargetLowering;
|
2002-05-07 19:37:18 +00:00
|
|
|
|
2003-09-01 20:44:42 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// RaisePointerReferences - Try to eliminate as many pointer arithmetic
|
|
|
|
// expressions as possible, by converting expressions to use getelementptr and
|
|
|
|
// friends.
|
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createRaisePointerReferencesPass();
|
2003-09-01 20:44:42 +00:00
|
|
|
|
2002-05-07 19:37:18 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2003-05-20 21:01:22 +00:00
|
|
|
// Constant Propagation Pass - A worklist driven constant propagation pass
|
2002-05-07 19:37:18 +00:00
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createConstantPropagationPass();
|
2002-05-07 19:37:18 +00:00
|
|
|
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2003-05-20 21:01:22 +00:00
|
|
|
// Sparse Conditional Constant Propagation Pass
|
2002-05-07 19:37:18 +00:00
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createSCCPPass();
|
2002-05-07 19:37:18 +00:00
|
|
|
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// DeadInstElimination - This pass quickly removes trivially dead instructions
|
|
|
|
// without modifying the CFG of the function. It is a BasicBlockPass, so it
|
|
|
|
// runs efficiently when queued next to other BasicBlockPass's.
|
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createDeadInstEliminationPass();
|
2002-05-07 19:37:18 +00:00
|
|
|
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// DeadCodeElimination - This pass is more powerful than DeadInstElimination,
|
|
|
|
// because it is worklist driven that can potentially revisit instructions when
|
|
|
|
// their other instructions become dead, to eliminate chains of dead
|
|
|
|
// computations.
|
|
|
|
//
|
2004-07-27 17:43:21 +00:00
|
|
|
FunctionPass *createDeadCodeEliminationPass();
|
2002-05-07 19:37:18 +00:00
|
|
|
|
2004-07-22 08:07:30 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// DeadStoreElimination - This pass deletes stores that are post-dominated by
|
|
|
|
// must-aliased stores and are not loaded used between the stores.
|
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createDeadStoreEliminationPass();
|
2002-05-07 19:37:18 +00:00
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2002-05-07 22:12:52 +00:00
|
|
|
// AggressiveDCE - This pass uses the SSA based Aggressive DCE algorithm. This
|
2002-05-07 19:37:18 +00:00
|
|
|
// algorithm assumes instructions are dead until proven otherwise, which makes
|
|
|
|
// it more successful are removing non-obviously dead instructions.
|
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createAggressiveDCEPass();
|
2002-05-07 19:37:18 +00:00
|
|
|
|
|
|
|
|
2003-05-27 15:52:45 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// Scalar Replacement of Aggregates - Break up alloca's of aggregates into
|
|
|
|
// multiple allocas if possible.
|
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createScalarReplAggregatesPass();
|
2003-05-27 15:52:45 +00:00
|
|
|
|
2002-05-07 19:37:18 +00:00
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
//
|
2003-11-07 17:19:39 +00:00
|
|
|
FunctionPass *createGCSEPass();
|
2002-05-07 19:37:18 +00:00
|
|
|
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// InductionVariableSimplify - Transform induction variables in a program to all
|
2003-09-10 05:29:43 +00:00
|
|
|
// use a single canonical induction variable per loop.
|
2002-05-07 19:37:18 +00:00
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createIndVarSimplifyPass();
|
2002-05-07 19:37:18 +00:00
|
|
|
|
|
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// InstructionCombining - Combine instructions to form fewer, simple
|
2004-02-13 16:23:14 +00:00
|
|
|
// instructions. This pass does not modify the CFG, and has a tendency to
|
2002-05-07 19:37:18 +00:00
|
|
|
// make instructions dead, so a subsequent DCE pass is useful.
|
|
|
|
//
|
|
|
|
// This pass combines things like:
|
|
|
|
// %Y = add int 1, %X
|
|
|
|
// %Z = add int 1, %Y
|
|
|
|
// into:
|
|
|
|
// %Z = add int 2, %X
|
|
|
|
//
|
2004-07-27 17:43:21 +00:00
|
|
|
FunctionPass *createInstructionCombiningPass();
|
2002-05-07 19:37:18 +00:00
|
|
|
|
|
|
|
|
2002-05-10 22:44:16 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2004-04-18 05:20:32 +00:00
|
|
|
// LICM - This pass is a loop invariant code motion and memory promotion pass.
|
2002-05-10 22:44:16 +00:00
|
|
|
//
|
2003-11-07 17:19:39 +00:00
|
|
|
FunctionPass *createLICMPass();
|
2002-05-10 22:44:16 +00:00
|
|
|
|
2004-10-18 21:08:22 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// LoopStrengthReduce - This pass is strength reduces GEP instructions that use
|
2006-03-16 21:53:05 +00:00
|
|
|
// 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);
|
2002-05-10 22:44:16 +00:00
|
|
|
|
2004-04-19 06:28:37 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// LoopUnswitch - This pass is a simple loop unswitching pass.
|
|
|
|
//
|
|
|
|
FunctionPass *createLoopUnswitchPass();
|
|
|
|
|
|
|
|
|
2004-04-18 05:20:32 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// LoopUnroll - This pass is a simple loop unrolling pass.
|
|
|
|
//
|
|
|
|
FunctionPass *createLoopUnrollPass();
|
|
|
|
|
2002-05-07 19:37:18 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// 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
|
|
|
|
// store int 42, int *%X
|
|
|
|
// %Y = load int* %X
|
|
|
|
// ret int %Y
|
|
|
|
//
|
2005-03-28 02:01:12 +00:00
|
|
|
FunctionPass *createPromoteMemoryToRegisterPass();
|
2006-05-02 04:24:36 +00:00
|
|
|
extern const PassInfo *PromoteMemoryToRegisterID;
|
2002-05-07 19:37:18 +00:00
|
|
|
|
2005-11-10 01:58:38 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This pass is used to demote registers to memory references .
|
|
|
|
// In basically undoes the PromoteMemoryToRegister pass to
|
|
|
|
// make cfg hacking easier.
|
|
|
|
FunctionPass *createDemoteRegisterToMemoryPass();
|
2005-11-22 22:14:23 +00:00
|
|
|
extern const PassInfo *DemoteRegisterToMemoryID;
|
2002-05-07 19:37:18 +00:00
|
|
|
|
2002-05-08 22:19:01 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This pass reassociates commutative expressions in an order that is designed
|
2003-05-20 21:01:22 +00:00
|
|
|
// to promote better constant propagation, GCSE, LICM, PRE...
|
2002-05-08 22:19:01 +00:00
|
|
|
//
|
|
|
|
// For example: 4 + (x + 5) -> x + (4 + 5)
|
|
|
|
//
|
2003-11-07 17:19:39 +00:00
|
|
|
FunctionPass *createReassociatePass();
|
2002-05-08 22:19:01 +00:00
|
|
|
|
2002-09-06 18:39:29 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// This pass eliminates correlated conditions, such as these:
|
|
|
|
// if (X == 0)
|
2002-09-24 15:42:27 +00:00
|
|
|
// if (X > 2) ; // Known false
|
2002-09-06 18:39:29 +00:00
|
|
|
// else
|
|
|
|
// Y = X * Z; // = 0
|
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createCorrelatedExpressionEliminationPass();
|
2002-05-08 22:19:01 +00:00
|
|
|
|
2005-04-15 19:24:49 +00:00
|
|
|
|
|
|
|
// createCondPropagationPass - This pass propagates information about
|
|
|
|
// conditional expressions through the program, allowing it to eliminate
|
|
|
|
// conditional branches in some cases.
|
|
|
|
//
|
|
|
|
FunctionPass *createCondPropagationPass();
|
|
|
|
|
2003-06-22 20:10:42 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// TailDuplication - Eliminate unconditional branches through controlled code
|
|
|
|
// duplication, creating simpler CFG structures.
|
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createTailDuplicationPass();
|
2003-06-22 20:10:42 +00:00
|
|
|
|
|
|
|
|
2002-05-21 20:04:15 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// CFG Simplification - Merge basic blocks, eliminate unreachable blocks,
|
|
|
|
// simplify terminator instructions, etc...
|
|
|
|
//
|
2003-10-05 19:15:13 +00:00
|
|
|
FunctionPass *createCFGSimplificationPass();
|
2002-05-21 20:04:15 +00:00
|
|
|
|
2003-06-22 20:10:42 +00:00
|
|
|
|
2002-09-24 00:08:37 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
|
|
|
// 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
|
2002-09-24 15:42:27 +00:00
|
|
|
// 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
|
2003-11-10 04:09:44 +00:00
|
|
|
// (set, immediate dominators, tree, and frontier) information.
|
2002-09-24 00:08:37 +00:00
|
|
|
//
|
2004-07-31 10:02:24 +00:00
|
|
|
FunctionPass *createBreakCriticalEdgesPass();
|
2002-09-24 15:42:27 +00:00
|
|
|
extern const PassInfo *BreakCriticalEdgesID;
|
2002-05-21 20:04:15 +00:00
|
|
|
|
2002-09-26 16:17:33 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2003-10-12 21:52:28 +00:00
|
|
|
// 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.
|
2002-09-26 16:17:33 +00:00
|
|
|
//
|
2003-10-12 21:52:28 +00:00
|
|
|
// AU.addRequiredID(LoopSimplifyID);
|
2002-09-26 16:17:33 +00:00
|
|
|
//
|
2004-09-20 04:41:39 +00:00
|
|
|
FunctionPass *createLoopSimplifyPass();
|
2003-10-12 21:52:28 +00:00
|
|
|
extern const PassInfo *LoopSimplifyID;
|
2002-09-26 16:17:33 +00:00
|
|
|
|
2003-09-20 05:14:13 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2006-05-02 04:24:36 +00:00
|
|
|
// 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.
|
2005-04-21 20:59:05 +00:00
|
|
|
//
|
2006-05-02 04:24:36 +00:00
|
|
|
FunctionPass *createLowerSelectPass(bool OnlyFP = false);
|
|
|
|
extern const PassInfo *LowerSelectID;
|
2002-09-26 16:17:33 +00:00
|
|
|
|
2002-07-23 19:37:38 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2006-05-02 04:24:36 +00:00
|
|
|
//
|
|
|
|
// LowerAllocations Pass - Turn malloc and free instructions into %malloc and
|
|
|
|
// %free calls.
|
|
|
|
//
|
|
|
|
// AU.addRequiredID(LowerAllocationsID);
|
2002-07-23 19:37:38 +00:00
|
|
|
//
|
2005-03-03 01:03:10 +00:00
|
|
|
FunctionPass *createLowerAllocationsPass(bool LowerMallocArgToInteger = false);
|
2006-05-02 04:24:36 +00:00
|
|
|
extern const PassInfo *LowerAllocationsID;
|
2002-07-23 19:37:38 +00:00
|
|
|
|
2003-04-23 16:24:19 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2006-05-02 04:24:36 +00:00
|
|
|
// This pass eliminates call instructions to the current function which occur
|
|
|
|
// immediately before return instructions.
|
|
|
|
//
|
|
|
|
FunctionPass *createTailCallEliminationPass();
|
2002-07-23 19:37:38 +00:00
|
|
|
|
2004-03-30 18:41:10 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2006-05-02 04:24:36 +00:00
|
|
|
// This pass converts SwitchInst instructions into a sequence of chained binary
|
|
|
|
// branch instructions.
|
2004-03-30 18:41:10 +00:00
|
|
|
//
|
2006-05-02 04:24:36 +00:00
|
|
|
FunctionPass *createLowerSwitchPass();
|
|
|
|
extern const PassInfo *LowerSwitchID;
|
2003-10-05 19:15:13 +00:00
|
|
|
|
2004-11-17 18:01:49 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// This pass converts PackedType operations into low-level scalar operations.
|
|
|
|
//
|
|
|
|
FunctionPass *createLowerPackedPass();
|
|
|
|
|
2003-10-05 19:15:13 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2004-03-31 21:59:07 +00:00
|
|
|
// 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
|
2004-05-23 21:16:13 +00:00
|
|
|
// 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.
|
2003-10-05 19:15:13 +00:00
|
|
|
//
|
2005-11-05 09:21:28 +00:00
|
|
|
FunctionPass *createLowerInvokePass(unsigned JumBufSize = 200,
|
|
|
|
unsigned JumpBufAlign = 0);
|
2004-02-13 16:16:35 +00:00
|
|
|
extern const PassInfo *LowerInvokePassID;
|
2003-10-05 19:15:13 +00:00
|
|
|
|
2005-04-21 20:59:05 +00:00
|
|
|
|
2004-05-23 21:16:13 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// createLowerGCPass - This function returns an instance of the "lowergc"
|
|
|
|
/// pass, which lowers garbage collection intrinsics to normal LLVM code.
|
|
|
|
///
|
|
|
|
FunctionPass *createLowerGCPass();
|
2004-06-25 07:41:06 +00:00
|
|
|
|
2005-01-08 17:21:40 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// This pass reorders basic blocks in order to increase the number of fall-
|
|
|
|
// through conditional branches.
|
|
|
|
FunctionPass *createBlockPlacementPass();
|
|
|
|
|
2006-05-26 13:58:26 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// This pass inserts phi nodes at loop boundaries to simplify other loop
|
|
|
|
// optimizations.
|
|
|
|
FunctionPass *createLCSSAPass();
|
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
} // End llvm namespace
|
|
|
|
|
2002-05-07 19:37:18 +00:00
|
|
|
#endif
|