include/llvm/Transforms/IPO.h

   1 //===- llvm/Transforms/IPO.h - Interprocedural 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 IPO transformations library.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_TRANSFORMS_IPO_H
  16 #define LLVM_TRANSFORMS_IPO_H
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19
  20 namespace llvm {
  21
  22 class ModulePass;
  23 class Pass;
  24 class Function;
  25 class BasicBlock;
  26 class GlobalValue;
  27
  28 //===----------------------------------------------------------------------===//
  29 //
  30 // These functions removes symbols from functions and modules.  If OnlyDebugInfo
  31 // is true, only debugging information is removed from the module.
  32 //
  33 ModulePass *createStripSymbolsPass(bool OnlyDebugInfo = false);
  34
  35 //===----------------------------------------------------------------------===//
  36 //
  37 // These functions strips symbols from functions and modules.
  38 // Only debugging information is not stripped.
  39 //
  40 ModulePass *createStripNonDebugSymbolsPass();
  41
  42 //===----------------------------------------------------------------------===//
  43 //
  44 // These pass removes llvm.dbg.declare intrinsics.
  45 ModulePass *createStripDebugDeclarePass();
  46
  47 //===----------------------------------------------------------------------===//
  48 //
  49 // These pass removes unused symbols' debug info.
  50 ModulePass *createStripDeadDebugInfoPass();
  51
  52 //===----------------------------------------------------------------------===//
  53 /// createConstantMergePass - This function returns a new pass that merges
  54 /// duplicate global constants together into a single constant that is shared.
  55 /// This is useful because some passes (ie TraceValues) insert a lot of string
  56 /// constants into the program, regardless of whether or not they duplicate an
  57 /// existing string.
  58 ///
  59 ModulePass *createConstantMergePass();
  60
  61
  62 //===----------------------------------------------------------------------===//
  63 /// createGlobalOptimizerPass - This function returns a new pass that optimizes
  64 /// non-address taken internal globals.
  65 ///
  66 ModulePass *createGlobalOptimizerPass();
  67
  68
  69 //===----------------------------------------------------------------------===//
  70 /// createGlobalDCEPass - This transform is designed to eliminate unreachable
  71 /// internal globals (functions or global variables)
  72 ///
  73 ModulePass *createGlobalDCEPass();
  74
  75
  76 //===----------------------------------------------------------------------===//
  77 /// createGVExtractionPass - If deleteFn is true, this pass deletes
  78 /// the specified global values. Otherwise, it deletes as much of the module as
  79 /// possible, except for the global values specified.
  80 ///
  81 ModulePass *createGVExtractionPass(std::vector<GlobalValue*>& GVs, bool
  82                                    deleteFn = false);
  83
  84 //===----------------------------------------------------------------------===//
  85 /// createFunctionInliningPass - Return a new pass object that uses a heuristic
  86 /// to inline direct function calls to small functions.
  87 ///
  88 /// The -inline-threshold command line option takes precedence over the
  89 /// threshold given here.
  90 Pass *createFunctionInliningPass();
  91 Pass *createFunctionInliningPass(int Threshold);
  92
  93 //===----------------------------------------------------------------------===//
  94 /// createAlwaysInlinerPass - Return a new pass object that inlines only
  95 /// functions that are marked as "always_inline".
  96 Pass *createAlwaysInlinerPass();
  97 Pass *createAlwaysInlinerPass(bool InsertLifetime);
  98
  99 //===----------------------------------------------------------------------===//
 100 /// createPruneEHPass - Return a new pass object which transforms invoke
 101 /// instructions into calls, if the callee can _not_ unwind the stack.
 102 ///
 103 Pass *createPruneEHPass();
 104
 105 //===----------------------------------------------------------------------===//
 106 /// createInternalizePass - This pass loops over all of the functions in the
 107 /// input module, internalizing all globals (functions and variables) it can.
 108 ////
 109 /// The symbols in \p ExportList are never internalized.
 110 ///
 111 /// When OnlyHidden=true, only symbols with hidden visibility are internalized.
 112 ///
 113 /// The symbol in DSOList are internalized if it is safe to drop them from
 114 /// the symbol table.
 115 ///
 116 /// Note that commandline options that are used with the above function are not
 117 /// used now!
 118 ModulePass *createInternalizePass(ArrayRef<const char *> ExportList,
 119                                   bool OnlyHidden = false);
 120 /// createInternalizePass - Same as above, but with an empty exportList.
 121 ModulePass *createInternalizePass(bool OnlyHidden = false);
 122
 123 //===----------------------------------------------------------------------===//
 124 /// createDeadArgEliminationPass - This pass removes arguments from functions
 125 /// which are not used by the body of the function.
 126 ///
 127 ModulePass *createDeadArgEliminationPass();
 128
 129 /// DeadArgHacking pass - Same as DAE, but delete arguments of external
 130 /// functions as well.  This is definitely not safe, and should only be used by
 131 /// bugpoint.
 132 ModulePass *createDeadArgHackingPass();
 133
 134 //===----------------------------------------------------------------------===//
 135 /// createArgumentPromotionPass - This pass promotes "by reference" arguments to
 136 /// be passed by value if the number of elements passed is smaller or
 137 /// equal to maxElements (maxElements == 0 means always promote).
 138 ///
 139 Pass *createArgumentPromotionPass(unsigned maxElements = 3);
 140
 141 //===----------------------------------------------------------------------===//
 142 /// createIPConstantPropagationPass - This pass propagates constants from call
 143 /// sites into the bodies of functions.
 144 ///
 145 ModulePass *createIPConstantPropagationPass();
 146
 147 //===----------------------------------------------------------------------===//
 148 /// createIPSCCPPass - This pass propagates constants from call sites into the
 149 /// bodies of functions, and keeps track of whether basic blocks are executable
 150 /// in the process.
 151 ///
 152 ModulePass *createIPSCCPPass();
 153
 154 //===----------------------------------------------------------------------===//
 155 //
 156 /// createLoopExtractorPass - This pass extracts all natural loops from the
 157 /// program into a function if it can.
 158 ///
 159 Pass *createLoopExtractorPass();
 160
 161 /// createSingleLoopExtractorPass - This pass extracts one natural loop from the
 162 /// program into a function if it can.  This is used by bugpoint.
 163 ///
 164 Pass *createSingleLoopExtractorPass();
 165
 166 /// createBlockExtractorPass - This pass extracts all blocks (except those
 167 /// specified in the argument list) from the functions in the module.
 168 ///
 169 ModulePass *createBlockExtractorPass();
 170
 171 /// createStripDeadPrototypesPass - This pass removes any function declarations
 172 /// (prototypes) that are not used.
 173 ModulePass *createStripDeadPrototypesPass();
 174
 175 //===----------------------------------------------------------------------===//
 176 /// createFunctionAttrsPass - This pass discovers functions that do not access
 177 /// memory, or only read memory, and gives them the readnone/readonly attribute.
 178 /// It also discovers function arguments that are not captured by the function
 179 /// and marks them with the nocapture attribute.
 180 ///
 181 Pass *createFunctionAttrsPass();
 182
 183 //===----------------------------------------------------------------------===//
 184 /// createMergeFunctionsPass - This pass discovers identical functions and
 185 /// collapses them.
 186 ///
 187 ModulePass *createMergeFunctionsPass();
 188
 189 //===----------------------------------------------------------------------===//
 190 /// createPartialInliningPass - This pass inlines parts of functions.
 191 ///
 192 ModulePass *createPartialInliningPass();
 193
 194 //===----------------------------------------------------------------------===//
 195 // createMetaRenamerPass - Rename everything with metasyntatic names.
 196 //
 197 ModulePass *createMetaRenamerPass();
 198
 199 //===----------------------------------------------------------------------===//
 200 /// createBarrierNoopPass - This pass is purely a module pass barrier in a pass
 201 /// manager.
 202 ModulePass *createBarrierNoopPass();
 203
 204 } // End llvm namespace
 205
 206 #endif