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