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 // LoopIndexSplit - This pass divides loop's iteration range by spliting loop
 135 // such that each individual loop is executed efficiently.
 136 //
 137 Pass *createLoopIndexSplitPass();
 138
 139 //===----------------------------------------------------------------------===//
 140 //
 141 // PromoteMemoryToRegister - This pass is used to promote memory references to
 142 // be register references. A simple example of the transformation performed by
 143 // this pass is:
 144 //
 145 //        FROM CODE                           TO CODE
 146 //   %X = alloca int, uint 1                 ret int 42
 147 //   store int 42, int *%X
 148 //   %Y = load int* %X
 149 //   ret int %Y
 150 //
 151 FunctionPass *createPromoteMemoryToRegisterPass();
 152 extern const PassInfo *const PromoteMemoryToRegisterID;
 153
 154 //===----------------------------------------------------------------------===//
 155 //
 156 // DemoteRegisterToMemoryPass - This pass is used to demote registers to memory
 157 // references. In basically undoes the PromoteMemoryToRegister pass to make cfg
 158 // hacking easier.
 159 //
 160 FunctionPass *createDemoteRegisterToMemoryPass();
 161 extern const PassInfo *const DemoteRegisterToMemoryID;
 162
 163 //===----------------------------------------------------------------------===//
 164 //
 165 // Reassociate - This pass reassociates commutative expressions in an order that
 166 // is designed to promote better constant propagation, GCSE, LICM, PRE...
 167 //
 168 // For example:  4 + (x + 5)  ->  x + (4 + 5)
 169 //
 170 FunctionPass *createReassociatePass();
 171
 172 //===----------------------------------------------------------------------===//
 173 //
 174 // CondPropagationPass - This pass propagates information about conditional
 175 // expressions through the program, allowing it to eliminate conditional
 176 // branches in some cases.
 177 //
 178 FunctionPass *createCondPropagationPass();
 179
 180 //===----------------------------------------------------------------------===//
 181 //
 182 // TailDuplication - Eliminate unconditional branches through controlled code
 183 // duplication, creating simpler CFG structures.
 184 //
 185 FunctionPass *createTailDuplicationPass();
 186
 187 //===----------------------------------------------------------------------===//
 188 //
 189 // JumpThreading - Thread control through mult-pred/multi-succ blocks where some
 190 // preds always go to some succ.
 191 //
 192 FunctionPass *createJumpThreadingPass();
 193
 194 //===----------------------------------------------------------------------===//
 195 //
 196 // CFGSimplification - Merge basic blocks, eliminate unreachable blocks,
 197 // simplify terminator instructions, etc...
 198 //
 199 FunctionPass *createCFGSimplificationPass();
 200
 201 //===----------------------------------------------------------------------===//
 202 //
 203 // BreakCriticalEdges - Break all of the critical edges in the CFG by inserting
 204 // a dummy basic block. This pass may be "required" by passes that cannot deal
 205 // with critical edges. For this usage, a pass must call:
 206 //
 207 //   AU.addRequiredID(BreakCriticalEdgesID);
 208 //
 209 // This pass obviously invalidates the CFG, but can update forward dominator
 210 // (set, immediate dominators, tree, and frontier) information.
 211 //
 212 FunctionPass *createBreakCriticalEdgesPass();
 213 extern const PassInfo *const BreakCriticalEdgesID;
 214
 215 //===----------------------------------------------------------------------===//
 216 //
 217 // LoopSimplify - Insert Pre-header blocks into the CFG for every function in
 218 // the module.  This pass updates dominator information, loop information, and
 219 // does not add critical edges to the CFG.
 220 //
 221 //   AU.addRequiredID(LoopSimplifyID);
 222 //
 223 FunctionPass *createLoopSimplifyPass();
 224 extern const PassInfo *const LoopSimplifyID;
 225
 226 //===----------------------------------------------------------------------===//
 227 //
 228 // LowerAllocations - Turn malloc and free instructions into %malloc and %free
 229 // calls.
 230 //
 231 //   AU.addRequiredID(LowerAllocationsID);
 232 //
 233 Pass *createLowerAllocationsPass(bool LowerMallocArgToInteger = false);
 234 extern const PassInfo *const LowerAllocationsID;
 235
 236 //===----------------------------------------------------------------------===//
 237 //
 238 // TailCallElimination - This pass eliminates call instructions to the current
 239 // function which occur immediately before return instructions.
 240 //
 241 FunctionPass *createTailCallEliminationPass();
 242
 243 //===----------------------------------------------------------------------===//
 244 //
 245 // LowerSwitch - This pass converts SwitchInst instructions into a sequence of
 246 // chained binary branch instructions.
 247 //
 248 FunctionPass *createLowerSwitchPass();
 249 extern const PassInfo *const LowerSwitchID;
 250
 251 //===----------------------------------------------------------------------===//
 252 //
 253 // LowerInvoke - This pass converts invoke and unwind instructions to use sjlj
 254 // exception handling mechanisms.  Note that after this pass runs the CFG is not
 255 // entirely accurate (exceptional control flow edges are not correct anymore) so
 256 // only very simple things should be done after the lowerinvoke pass has run
 257 // (like generation of native code).  This should *NOT* be used as a general
 258 // purpose "my LLVM-to-LLVM pass doesn't support the invoke instruction yet"
 259 // lowering pass.
 260 //
 261 FunctionPass *createLowerInvokePass(const TargetLowering *TLI = 0);
 262 extern const PassInfo *const LowerInvokePassID;
 263
 264 //===----------------------------------------------------------------------===//
 265 //
 266 // BlockPlacement - This pass reorders basic blocks in order to increase the
 267 // number of fall-through conditional branches.
 268 //
 269 FunctionPass *createBlockPlacementPass();
 270
 271 //===----------------------------------------------------------------------===//
 272 //
 273 // LCSSA - This pass inserts phi nodes at loop boundaries to simplify other loop
 274 // optimizations.
 275 //
 276 Pass *createLCSSAPass();
 277 extern const PassInfo *const LCSSAID;
 278
 279 //===----------------------------------------------------------------------===//
 280 //
 281 // PredicateSimplifier - This pass collapses duplicate variables into one
 282 // canonical form, and tries to simplify expressions along the way.
 283 //
 284 FunctionPass *createPredicateSimplifierPass();
 285
 286 //===----------------------------------------------------------------------===//
 287 //
 288 // GVN-PRE - This pass performs global value numbering and partial redundancy
 289 // elimination.
 290 //
 291 FunctionPass *createGVNPREPass();
 292
 293 //===----------------------------------------------------------------------===//
 294 //
 295 // GVN - This pass performs global value numbering and redundant load
 296 // elimination cotemporaneously.
 297 //
 298 FunctionPass *createGVNPass();
 299
 300 //===----------------------------------------------------------------------===//
 301 //
 302 // MemCpyOpt - This pass performs optimizations related to eliminating memcpy
 303 // calls and/or combining multiple stores into memset's.
 304 //
 305 FunctionPass *createMemCpyOptPass();
 306
 307 //===----------------------------------------------------------------------===//
 308 //
 309 // LoopDeletion - This pass performs DCE of non-infinite loops that it
 310 // can prove are dead.
 311 //
 312 Pass *createLoopDeletionPass();
 313
 314 //===----------------------------------------------------------------------===//
 315 //
 316 /// createSimplifyLibCallsPass - This pass optimizes specific calls to
 317 /// specific well-known (library) functions.
 318 FunctionPass *createSimplifyLibCallsPass();
 319
 320 //===----------------------------------------------------------------------===//
 321 //
 322 // CodeGenPrepare - This pass prepares a function for instruction selection.
 323 //
 324 FunctionPass *createCodeGenPreparePass(const TargetLowering *TLI = 0);
 325
 326
 327 //===----------------------------------------------------------------------===//
 328 //
 329 // InstructionNamer - Give any unnamed non-void instructions "tmp" names.
 330 //
 331 FunctionPass *createInstructionNamerPass();
 332
 333 } // End llvm namespace
 334
 335 #endif