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 #include "llvm/ADT/StringRef.h"
  19
  20 namespace llvm {
  21
  22 class FunctionPass;
  23 class Pass;
  24 class GetElementPtrInst;
  25 class PassInfo;
  26 class TerminatorInst;
  27 class TargetLowering;
  28 class TargetMachine;
  29
  30 //===----------------------------------------------------------------------===//
  31 //
  32 // ConstantPropagation - A worklist driven constant propagation pass
  33 //
  34 FunctionPass *createConstantPropagationPass();
  35
  36 //===----------------------------------------------------------------------===//
  37 //
  38 // SCCP - Sparse conditional constant propagation.
  39 //
  40 FunctionPass *createSCCPPass();
  41
  42 //===----------------------------------------------------------------------===//
  43 //
  44 // DeadInstElimination - This pass quickly removes trivially dead instructions
  45 // without modifying the CFG of the function.  It is a BasicBlockPass, so it
  46 // runs efficiently when queued next to other BasicBlockPass's.
  47 //
  48 Pass *createDeadInstEliminationPass();
  49
  50 //===----------------------------------------------------------------------===//
  51 //
  52 // DeadCodeElimination - This pass is more powerful than DeadInstElimination,
  53 // because it is worklist driven that can potentially revisit instructions when
  54 // their other instructions become dead, to eliminate chains of dead
  55 // computations.
  56 //
  57 FunctionPass *createDeadCodeEliminationPass();
  58
  59 //===----------------------------------------------------------------------===//
  60 //
  61 // DeadStoreElimination - This pass deletes stores that are post-dominated by
  62 // must-aliased stores and are not loaded used between the stores.
  63 //
  64 FunctionPass *createDeadStoreEliminationPass();
  65
  66 //===----------------------------------------------------------------------===//
  67 //
  68 // AggressiveDCE - This pass uses the SSA based Aggressive DCE algorithm.  This
  69 // algorithm assumes instructions are dead until proven otherwise, which makes
  70 // it more successful are removing non-obviously dead instructions.
  71 //
  72 FunctionPass *createAggressiveDCEPass();
  73
  74 //===----------------------------------------------------------------------===//
  75 //
  76 // SROA - Replace aggregates or pieces of aggregates with scalar SSA values.
  77 //
  78 FunctionPass *createSROAPass(bool RequiresDomTree = true);
  79
  80 //===----------------------------------------------------------------------===//
  81 //
  82 // ScalarReplAggregates - Break up alloca's of aggregates into multiple allocas
  83 // if possible.
  84 //
  85 FunctionPass *createScalarReplAggregatesPass(signed Threshold = -1,
  86                                              bool UseDomTree = true,
  87                                              signed StructMemberThreshold = -1,
  88                                              signed ArrayElementThreshold = -1,
  89                                              signed ScalarLoadThreshold = -1);
  90
  91 //===----------------------------------------------------------------------===//
  92 //
  93 // InductionVariableSimplify - Transform induction variables in a program to all
  94 // use a single canonical induction variable per loop.
  95 //
  96 Pass *createIndVarSimplifyPass();
  97
  98 //===----------------------------------------------------------------------===//
  99 //
 100 // InstructionCombining - Combine instructions to form fewer, simple
 101 // instructions. This pass does not modify the CFG, and has a tendency to make
 102 // instructions dead, so a subsequent DCE pass is useful.
 103 //
 104 // This pass combines things like:
 105 //    %Y = add int 1, %X
 106 //    %Z = add int 1, %Y
 107 // into:
 108 //    %Z = add int 2, %X
 109 //
 110 FunctionPass *createInstructionCombiningPass();
 111
 112 //===----------------------------------------------------------------------===//
 113 //
 114 // LICM - This pass is a loop invariant code motion and memory promotion pass.
 115 //
 116 Pass *createLICMPass();
 117
 118 //===----------------------------------------------------------------------===//
 119 //
 120 // LoopStrengthReduce - This pass is strength reduces GEP instructions that use
 121 // a loop's canonical induction variable as one of their indices.
 122 //
 123 Pass *createLoopStrengthReducePass();
 124
 125 Pass *createGlobalMergePass(const TargetMachine *TM = 0);
 126
 127 //===----------------------------------------------------------------------===//
 128 //
 129 // LoopUnswitch - This pass is a simple loop unswitching pass.
 130 //
 131 Pass *createLoopUnswitchPass(bool OptimizeForSize = false);
 132
 133 //===----------------------------------------------------------------------===//
 134 //
 135 // LoopInstSimplify - This pass simplifies instructions in a loop's body.
 136 //
 137 Pass *createLoopInstSimplifyPass();
 138
 139 //===----------------------------------------------------------------------===//
 140 //
 141 // LoopUnroll - This pass is a simple loop unrolling pass.
 142 //
 143 Pass *createLoopUnrollPass(int Threshold = -1, int Count = -1,
 144                            int AllowPartial = -1, int Runtime = -1);
 145
 146 //===----------------------------------------------------------------------===//
 147 //
 148 // LoopRotate - This pass is a simple loop rotating pass.
 149 //
 150 Pass *createLoopRotatePass();
 151
 152 //===----------------------------------------------------------------------===//
 153 //
 154 // LoopIdiom - This pass recognizes and replaces idioms in loops.
 155 //
 156 Pass *createLoopIdiomPass();
 157
 158 //===----------------------------------------------------------------------===//
 159 //
 160 // PromoteMemoryToRegister - This pass is used to promote memory references to
 161 // be register references. A simple example of the transformation performed by
 162 // this pass is:
 163 //
 164 //        FROM CODE                           TO CODE
 165 //   %X = alloca i32, i32 1                 ret i32 42
 166 //   store i32 42, i32 *%X
 167 //   %Y = load i32* %X
 168 //   ret i32 %Y
 169 //
 170 FunctionPass *createPromoteMemoryToRegisterPass();
 171
 172 //===----------------------------------------------------------------------===//
 173 //
 174 // DemoteRegisterToMemoryPass - This pass is used to demote registers to memory
 175 // references. In basically undoes the PromoteMemoryToRegister pass to make cfg
 176 // hacking easier.
 177 //
 178 FunctionPass *createDemoteRegisterToMemoryPass();
 179 extern char &DemoteRegisterToMemoryID;
 180
 181 //===----------------------------------------------------------------------===//
 182 //
 183 // Reassociate - This pass reassociates commutative expressions in an order that
 184 // is designed to promote better constant propagation, GCSE, LICM, PRE...
 185 //
 186 // For example:  4 + (x + 5)  ->  x + (4 + 5)
 187 //
 188 FunctionPass *createReassociatePass();
 189
 190 //===----------------------------------------------------------------------===//
 191 //
 192 // JumpThreading - Thread control through mult-pred/multi-succ blocks where some
 193 // preds always go to some succ.
 194 //
 195 FunctionPass *createJumpThreadingPass();
 196
 197 //===----------------------------------------------------------------------===//
 198 //
 199 // CFGSimplification - Merge basic blocks, eliminate unreachable blocks,
 200 // simplify terminator instructions, etc...
 201 //
 202 FunctionPass *createCFGSimplificationPass();
 203
 204 //===----------------------------------------------------------------------===//
 205 //
 206 // FlattenCFG - flatten CFG, reduce number of conditional branches by using
 207 // parallel-and and parallel-or mode, etc...
 208 //
 209 FunctionPass *createFlattenCFGPass();
 210
 211 //===----------------------------------------------------------------------===//
 212 //
 213 // CFG Structurization - Remove irreducible control flow
 214 //
 215 Pass *createStructurizeCFGPass();
 216
 217 //===----------------------------------------------------------------------===//
 218 //
 219 // BreakCriticalEdges - Break all of the critical edges in the CFG by inserting
 220 // a dummy basic block. This pass may be "required" by passes that cannot deal
 221 // with critical edges. For this usage, a pass must call:
 222 //
 223 //   AU.addRequiredID(BreakCriticalEdgesID);
 224 //
 225 // This pass obviously invalidates the CFG, but can update forward dominator
 226 // (set, immediate dominators, tree, and frontier) information.
 227 //
 228 FunctionPass *createBreakCriticalEdgesPass();
 229 extern char &BreakCriticalEdgesID;
 230
 231 //===----------------------------------------------------------------------===//
 232 //
 233 // LoopSimplify - Insert Pre-header blocks into the CFG for every function in
 234 // the module.  This pass updates dominator information, loop information, and
 235 // does not add critical edges to the CFG.
 236 //
 237 //   AU.addRequiredID(LoopSimplifyID);
 238 //
 239 Pass *createLoopSimplifyPass();
 240 extern char &LoopSimplifyID;
 241
 242 //===----------------------------------------------------------------------===//
 243 //
 244 // TailCallElimination - This pass eliminates call instructions to the current
 245 // function which occur immediately before return instructions.
 246 //
 247 FunctionPass *createTailCallEliminationPass();
 248
 249 //===----------------------------------------------------------------------===//
 250 //
 251 // LowerSwitch - This pass converts SwitchInst instructions into a sequence of
 252 // chained binary branch instructions.
 253 //
 254 FunctionPass *createLowerSwitchPass();
 255 extern char &LowerSwitchID;
 256
 257 //===----------------------------------------------------------------------===//
 258 //
 259 // LowerInvoke - This pass converts invoke and unwind instructions to use sjlj
 260 // exception handling mechanisms.  Note that after this pass runs the CFG is not
 261 // entirely accurate (exceptional control flow edges are not correct anymore) so
 262 // only very simple things should be done after the lowerinvoke pass has run
 263 // (like generation of native code).  This should *NOT* be used as a general
 264 // purpose "my LLVM-to-LLVM pass doesn't support the invoke instruction yet"
 265 // lowering pass.
 266 //
 267 FunctionPass *createLowerInvokePass(const TargetMachine *TM = 0,
 268                                     bool useExpensiveEHSupport = false);
 269 extern char &LowerInvokePassID;
 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 char &LCSSAID;
 278
 279 //===----------------------------------------------------------------------===//
 280 //
 281 // EarlyCSE - This pass performs a simple and fast CSE pass over the dominator
 282 // tree.
 283 //
 284 FunctionPass *createEarlyCSEPass();
 285
 286 //===----------------------------------------------------------------------===//
 287 //
 288 // GVN - This pass performs global value numbering and redundant load
 289 // elimination cotemporaneously.
 290 //
 291 FunctionPass *createGVNPass(bool NoLoads = false);
 292
 293 //===----------------------------------------------------------------------===//
 294 //
 295 // MemCpyOpt - This pass performs optimizations related to eliminating memcpy
 296 // calls and/or combining multiple stores into memset's.
 297 //
 298 FunctionPass *createMemCpyOptPass();
 299
 300 //===----------------------------------------------------------------------===//
 301 //
 302 // LoopDeletion - This pass performs DCE of non-infinite loops that it
 303 // can prove are dead.
 304 //
 305 Pass *createLoopDeletionPass();
 306
 307 //===----------------------------------------------------------------------===//
 308 //
 309 // CodeGenPrepare - This pass prepares a function for instruction selection.
 310 //
 311 FunctionPass *createCodeGenPreparePass(const TargetMachine *TM = 0);
 312
 313 //===----------------------------------------------------------------------===//
 314 //
 315 // InstructionNamer - Give any unnamed non-void instructions "tmp" names.
 316 //
 317 FunctionPass *createInstructionNamerPass();
 318 extern char &InstructionNamerID;
 319
 320 //===----------------------------------------------------------------------===//
 321 //
 322 // Sink - Code Sinking
 323 //
 324 FunctionPass *createSinkingPass();
 325
 326 //===----------------------------------------------------------------------===//
 327 //
 328 // LowerAtomic - Lower atomic intrinsics to non-atomic form
 329 //
 330 Pass *createLowerAtomicPass();
 331
 332 //===----------------------------------------------------------------------===//
 333 //
 334 // ValuePropagation - Propagate CFG-derived value information
 335 //
 336 Pass *createCorrelatedValuePropagationPass();
 337
 338 //===----------------------------------------------------------------------===//
 339 //
 340 // InstructionSimplifier - Remove redundant instructions.
 341 //
 342 FunctionPass *createInstructionSimplifierPass();
 343 extern char &InstructionSimplifierID;
 344
 345
 346 //===----------------------------------------------------------------------===//
 347 //
 348 // LowerExpectIntrinsics - Removes llvm.expect intrinsics and creates
 349 // "block_weights" metadata.
 350 FunctionPass *createLowerExpectIntrinsicPass();
 351
 352
 353 //===----------------------------------------------------------------------===//
 354 //
 355 // PartiallyInlineLibCalls - Tries to inline the fast path of library
 356 // calls such as sqrt.
 357 //
 358 FunctionPass *createPartiallyInlineLibCallsPass();
 359
 360 //===----------------------------------------------------------------------===//
 361 //
 362 // SampleProfilePass - Loads sample profile data from disk and generates
 363 // IR metadata to reflect the profile.
 364 FunctionPass *createSampleProfileLoaderPass();
 365 FunctionPass *createSampleProfileLoaderPass(StringRef Name);
 366
 367 } // End llvm namespace
 368
 369 #endif