include/llvm/Transforms/Scalar.h

   1 //===-- Scalar.h - Scalar Transformations -----------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This header file defines prototypes for accessor functions that expose passes
  11 // in the Scalar transformations library.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_TRANSFORMS_SCALAR_H
  16 #define LLVM_TRANSFORMS_SCALAR_H
  17
  18 namespace llvm {
  19
  20 class FunctionPass;
  21 class Pass;
  22 class GetElementPtrInst;
  23 class PassInfo;
  24 class TerminatorInst;
  25 class TargetLowering;
  26
  27 //===----------------------------------------------------------------------===//
  28 //
  29 // ConstantPropagation - A worklist driven constant propagation pass
  30 //
  31 FunctionPass *createConstantPropagationPass();
  32
  33 //===----------------------------------------------------------------------===//
  34 //
  35 // SCCP - Sparse conditional constant propagation.
  36 //
  37 FunctionPass *createSCCPPass();
  38
  39 //===----------------------------------------------------------------------===//
  40 //
  41 // DeadInstElimination - This pass quickly removes trivially dead instructions
  42 // without modifying the CFG of the function.  It is a BasicBlockPass, so it
  43 // runs efficiently when queued next to other BasicBlockPass's.
  44 //
  45 Pass *createDeadInstEliminationPass();
  46
  47 //===----------------------------------------------------------------------===//
  48 //
  49 // DeadCodeElimination - This pass is more powerful than DeadInstElimination,
  50 // because it is worklist driven that can potentially revisit instructions when
  51 // their other instructions become dead, to eliminate chains of dead
  52 // computations.
  53 //
  54 FunctionPass *createDeadCodeEliminationPass();
  55
  56 //===----------------------------------------------------------------------===//
  57 //
  58 // DeadStoreElimination - This pass deletes stores that are post-dominated by
  59 // must-aliased stores and are not loaded used between the stores.
  60 //
  61 FunctionPass *createDeadStoreEliminationPass();
  62
  63 //===----------------------------------------------------------------------===//
  64 //
  65 // AggressiveDCE - This pass uses the SSA based Aggressive DCE algorithm.  This
  66 // algorithm assumes instructions are dead until proven otherwise, which makes
  67 // it more successful are removing non-obviously dead instructions.
  68 //
  69 FunctionPass *createAggressiveDCEPass();
  70
  71 //===----------------------------------------------------------------------===//
  72 //
  73 // ScalarReplAggregates - Break up alloca's of aggregates into multiple allocas
  74 // if possible.
  75 //
  76 FunctionPass *createScalarReplAggregatesPass(signed Threshold = -1);
  77
  78 //===----------------------------------------------------------------------===//
  79 //
  80 // InductionVariableSimplify - Transform induction variables in a program to all
  81 // use a single canonical induction variable per loop.
  82 //
  83 Pass *createIndVarSimplifyPass();
  84
  85 //===----------------------------------------------------------------------===//
  86 //
  87 // InstructionCombining - Combine instructions to form fewer, simple
  88 // instructions. This pass does not modify the CFG, and has a tendency to make
  89 // instructions dead, so a subsequent DCE pass is useful.
  90 //
  91 // This pass combines things like:
  92 //    %Y = add int 1, %X
  93 //    %Z = add int 1, %Y
  94 // into:
  95 //    %Z = add int 2, %X
  96 //
  97 FunctionPass *createInstructionCombiningPass();
  98
  99 //===----------------------------------------------------------------------===//
 100 //
 101 // LICM - This pass is a loop invariant code motion and memory promotion pass.
 102 //
 103 Pass *createLICMPass();
 104
 105 //===----------------------------------------------------------------------===//
 106 //
 107 // LoopStrengthReduce - This pass is strength reduces GEP instructions that use
 108 // a loop's canonical induction variable as one of their indices.  It takes an
 109 // optional parameter used to consult the target machine whether certain
 110 // transformations are profitable.
 111 //
 112 Pass *createLoopStrengthReducePass(const TargetLowering *TLI = 0);
 113
 114 //===----------------------------------------------------------------------===//
 115 //
 116 // LoopUnswitch - This pass is a simple loop unswitching pass.
 117 //
 118 Pass *createLoopUnswitchPass(bool OptimizeForSize = false);
 119
 120 //===----------------------------------------------------------------------===//
 121 //
 122 // LoopUnroll - This pass is a simple loop unrolling pass.
 123 //
 124 Pass *createLoopUnrollPass();
 125
 126 //===----------------------------------------------------------------------===//
 127 //
 128 // LoopRotate - This pass is a simple loop rotating pass.
 129 //
 130 Pass *createLoopRotatePass();
 131
 132 //===----------------------------------------------------------------------===//
 133 //
 134 // PromoteMemoryToRegister - This pass is used to promote memory references to
 135 // be register references. A simple example of the transformation performed by
 136 // this pass is:
 137 //
 138 //        FROM CODE                           TO CODE
 139 //   %X = alloca i32, i32 1                 ret i32 42
 140 //   store i32 42, i32 *%X
 141 //   %Y = load i32* %X
 142 //   ret i32 %Y
 143 //
 144 FunctionPass *createPromoteMemoryToRegisterPass();
 145
 146 //===----------------------------------------------------------------------===//
 147 //
 148 // DemoteRegisterToMemoryPass - This pass is used to demote registers to memory
 149 // references. In basically undoes the PromoteMemoryToRegister pass to make cfg
 150 // hacking easier.
 151 //
 152 FunctionPass *createDemoteRegisterToMemoryPass();
 153 extern char &DemoteRegisterToMemoryID;
 154
 155 //===----------------------------------------------------------------------===//
 156 //
 157 // Reassociate - This pass reassociates commutative expressions in an order that
 158 // is designed to promote better constant propagation, GCSE, LICM, PRE...
 159 //
 160 // For example:  4 + (x + 5)  ->  x + (4 + 5)
 161 //
 162 FunctionPass *createReassociatePass();
 163
 164 //===----------------------------------------------------------------------===//
 165 //
 166 // TailDuplication - Eliminate unconditional branches through controlled code
 167 // duplication, creating simpler CFG structures.
 168 //
 169 FunctionPass *createTailDuplicationPass();
 170
 171 //===----------------------------------------------------------------------===//
 172 //
 173 // JumpThreading - Thread control through mult-pred/multi-succ blocks where some
 174 // preds always go to some succ.
 175 //
 176 FunctionPass *createJumpThreadingPass();
 177
 178 //===----------------------------------------------------------------------===//
 179 //
 180 // CFGSimplification - Merge basic blocks, eliminate unreachable blocks,
 181 // simplify terminator instructions, etc...
 182 //
 183 FunctionPass *createCFGSimplificationPass();
 184
 185 //===----------------------------------------------------------------------===//
 186 //
 187 // BreakCriticalEdges - Break all of the critical edges in the CFG by inserting
 188 // a dummy basic block. This pass may be "required" by passes that cannot deal
 189 // with critical edges. For this usage, a pass must call:
 190 //
 191 //   AU.addRequiredID(BreakCriticalEdgesID);
 192 //
 193 // This pass obviously invalidates the CFG, but can update forward dominator
 194 // (set, immediate dominators, tree, and frontier) information.
 195 //
 196 FunctionPass *createBreakCriticalEdgesPass();
 197 extern char &BreakCriticalEdgesID;
 198
 199 //===----------------------------------------------------------------------===//
 200 //
 201 // LoopSimplify - Insert Pre-header blocks into the CFG for every function in
 202 // the module.  This pass updates dominator information, loop information, and
 203 // does not add critical edges to the CFG.
 204 //
 205 //   AU.addRequiredID(LoopSimplifyID);
 206 //
 207 Pass *createLoopSimplifyPass();
 208 extern char &LoopSimplifyID;
 209
 210 //===----------------------------------------------------------------------===//
 211 //
 212 // TailCallElimination - This pass eliminates call instructions to the current
 213 // function which occur immediately before return instructions.
 214 //
 215 FunctionPass *createTailCallEliminationPass();
 216
 217 //===----------------------------------------------------------------------===//
 218 //
 219 // LowerSwitch - This pass converts SwitchInst instructions into a sequence of
 220 // chained binary branch instructions.
 221 //
 222 FunctionPass *createLowerSwitchPass();
 223 extern char &LowerSwitchID;
 224
 225 //===----------------------------------------------------------------------===//
 226 //
 227 // LowerInvoke - This pass converts invoke and unwind instructions to use sjlj
 228 // exception handling mechanisms.  Note that after this pass runs the CFG is not
 229 // entirely accurate (exceptional control flow edges are not correct anymore) so
 230 // only very simple things should be done after the lowerinvoke pass has run
 231 // (like generation of native code).  This should *NOT* be used as a general
 232 // purpose "my LLVM-to-LLVM pass doesn't support the invoke instruction yet"
 233 // lowering pass.
 234 //
 235 FunctionPass *createLowerInvokePass(const TargetLowering *TLI = 0);
 236 FunctionPass *createLowerInvokePass(const TargetLowering *TLI,
 237                                     bool useExpensiveEHSupport);
 238 extern char &LowerInvokePassID;
 239
 240 //===----------------------------------------------------------------------===//
 241 //
 242 // BlockPlacement - This pass reorders basic blocks in order to increase the
 243 // number of fall-through conditional branches.
 244 //
 245 FunctionPass *createBlockPlacementPass();
 246
 247 //===----------------------------------------------------------------------===//
 248 //
 249 // LCSSA - This pass inserts phi nodes at loop boundaries to simplify other loop
 250 // optimizations.
 251 //
 252 Pass *createLCSSAPass();
 253 extern char &LCSSAID;
 254
 255 //===----------------------------------------------------------------------===//
 256 //
 257 // GVN - This pass performs global value numbering and redundant load
 258 // elimination cotemporaneously.
 259 //
 260 FunctionPass *createGVNPass(bool NoLoads = false);
 261
 262 //===----------------------------------------------------------------------===//
 263 //
 264 // MemCpyOpt - This pass performs optimizations related to eliminating memcpy
 265 // calls and/or combining multiple stores into memset's.
 266 //
 267 FunctionPass *createMemCpyOptPass();
 268
 269 //===----------------------------------------------------------------------===//
 270 //
 271 // LoopDeletion - This pass performs DCE of non-infinite loops that it
 272 // can prove are dead.
 273 //
 274 Pass *createLoopDeletionPass();
 275
 276 //===----------------------------------------------------------------------===//
 277 //
 278 /// createSimplifyLibCallsPass - This pass optimizes specific calls to
 279 /// specific well-known (library) functions.
 280 FunctionPass *createSimplifyLibCallsPass();
 281
 282 //===----------------------------------------------------------------------===//
 283 //
 284 /// createSimplifyHalfPowrLibCallsPass - This is an experimental pass that
 285 /// optimizes specific half_pow functions.
 286 FunctionPass *createSimplifyHalfPowrLibCallsPass();
 287
 288 //===----------------------------------------------------------------------===//
 289 //
 290 // CodeGenPrepare - This pass prepares a function for instruction selection.
 291 //
 292 FunctionPass *createCodeGenPreparePass(const TargetLowering *TLI = 0);
 293
 294 //===----------------------------------------------------------------------===//
 295 //
 296 // InstructionNamer - Give any unnamed non-void instructions "tmp" names.
 297 //
 298 FunctionPass *createInstructionNamerPass();
 299 extern char &InstructionNamerID;
 300
 301 //===----------------------------------------------------------------------===//
 302 //
 303 // GEPSplitter - Split complex GEPs into simple ones
 304 //
 305 FunctionPass *createGEPSplitterPass();
 306
 307 //===----------------------------------------------------------------------===//
 308 //
 309 // Sink - Code Sinking
 310 //
 311 FunctionPass *createSinkingPass();
 312
 313 //===----------------------------------------------------------------------===//
 314 //
 315 // LowerAtomic - Lower atomic intrinsics to non-atomic form
 316 //
 317 Pass *createLowerAtomicPass();
 318
 319 //===----------------------------------------------------------------------===//
 320 //
 321 // ValuePropagation - Propagate CFG-derived value information
 322 //
 323 Pass *createCorrelatedValuePropagationPass();
 324
 325 //===----------------------------------------------------------------------===//
 326 //
 327 // InstructionSimplifier - Remove redundant instructions.
 328 //
 329 FunctionPass *createInstructionSimplifierPass();
 330 extern char &InstructionSimplifierID;
 331
 332 } // End llvm namespace
 333
 334 #endif