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 <vector>
  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 /// createLowerSetJmpPass - This function lowers the setjmp/longjmp intrinsics
  54 /// to invoke/unwind instructions.  This should really be part of the C/C++
  55 /// front-end, but it's so much easier to write transformations in LLVM proper.
  56 ///
  57 ModulePass *createLowerSetJmpPass();
  58
  59 //===----------------------------------------------------------------------===//
  60 /// createConstantMergePass - This function returns a new pass that merges
  61 /// duplicate global constants together into a single constant that is shared.
  62 /// This is useful because some passes (ie TraceValues) insert a lot of string
  63 /// constants into the program, regardless of whether or not they duplicate an
  64 /// existing string.
  65 ///
  66 ModulePass *createConstantMergePass();
  67
  68
  69 //===----------------------------------------------------------------------===//
  70 /// createGlobalOptimizerPass - This function returns a new pass that optimizes
  71 /// non-address taken internal globals.
  72 ///
  73 ModulePass *createGlobalOptimizerPass();
  74
  75
  76 //===----------------------------------------------------------------------===//
  77 /// createGlobalDCEPass - This transform is designed to eliminate unreachable
  78 /// internal globals (functions or global variables)
  79 ///
  80 ModulePass *createGlobalDCEPass();
  81
  82
  83 //===----------------------------------------------------------------------===//
  84 /// createGVExtractionPass - If deleteFn is true, this pass deletes as
  85 /// the specified global values. Otherwise, it deletes as much of the module as
  86 /// possible, except for the global values specified.
  87 ///
  88 ModulePass *createGVExtractionPass(std::vector<GlobalValue*>& GVs, bool
  89                                    deleteFn = false);
  90
  91 //===----------------------------------------------------------------------===//
  92 /// createFunctionInliningPass - Return a new pass object that uses a heuristic
  93 /// to inline direct function calls to small functions.
  94 ///
  95 /// The -inline-threshold command line option takes precedence over the
  96 /// threshold given here.
  97 Pass *createFunctionInliningPass();
  98 Pass *createFunctionInliningPass(int Threshold);
  99
 100 //===----------------------------------------------------------------------===//
 101 /// createAlwaysInlinerPass - Return a new pass object that inlines only
 102 /// functions that are marked as "always_inline".
 103 Pass *createAlwaysInlinerPass();
 104
 105 //===----------------------------------------------------------------------===//
 106 /// createPruneEHPass - Return a new pass object which transforms invoke
 107 /// instructions into calls, if the callee can _not_ unwind the stack.
 108 ///
 109 Pass *createPruneEHPass();
 110
 111 //===----------------------------------------------------------------------===//
 112 /// createInternalizePass - This pass loops over all of the functions in the
 113 /// input module, internalizing all globals (functions and variables) not part
 114 /// of the api.  If a list of symbols is specified with the
 115 /// -internalize-public-api-* command line options, those symbols are not
 116 /// internalized and all others are.  Otherwise if AllButMain is set and the
 117 /// main function is found, all other globals are marked as internal. If no api
 118 /// is supplied and AllButMain is not set, or no main function is found, nothing
 119 /// is internalized.
 120 ///
 121 ModulePass *createInternalizePass(bool AllButMain);
 122
 123 /// createInternalizePass - This pass loops over all of the functions in the
 124 /// input module, internalizing all globals (functions and variables) not in the
 125 /// given exportList.
 126 ///
 127 /// Note that commandline options that are used with the above function are not
 128 /// used now! Also, when exportList is empty, nothing is internalized.
 129 ModulePass *createInternalizePass(const std::vector<const char *> &exportList);
 130
 131 //===----------------------------------------------------------------------===//
 132 /// createDeadArgEliminationPass - This pass removes arguments from functions
 133 /// which are not used by the body of the function.
 134 ///
 135 ModulePass *createDeadArgEliminationPass();
 136
 137 /// DeadArgHacking pass - Same as DAE, but delete arguments of external
 138 /// functions as well.  This is definitely not safe, and should only be used by
 139 /// bugpoint.
 140 ModulePass *createDeadArgHackingPass();
 141
 142 //===----------------------------------------------------------------------===//
 143 /// createArgumentPromotionPass - This pass promotes "by reference" arguments to
 144 /// be passed by value if the number of elements passed is smaller or
 145 /// equal to maxElements (maxElements == 0 means always promote).
 146 ///
 147 Pass *createArgumentPromotionPass(unsigned maxElements = 3);
 148
 149 //===----------------------------------------------------------------------===//
 150 /// createIPConstantPropagationPass - This pass propagates constants from call
 151 /// sites into the bodies of functions.
 152 ///
 153 ModulePass *createIPConstantPropagationPass();
 154
 155 //===----------------------------------------------------------------------===//
 156 /// createIPSCCPPass - This pass propagates constants from call sites into the
 157 /// bodies of functions, and keeps track of whether basic blocks are executable
 158 /// in the process.
 159 ///
 160 ModulePass *createIPSCCPPass();
 161
 162 //===----------------------------------------------------------------------===//
 163 //
 164 /// createLoopExtractorPass - This pass extracts all natural loops from the
 165 /// program into a function if it can.
 166 ///
 167 Pass *createLoopExtractorPass();
 168
 169 /// createSingleLoopExtractorPass - This pass extracts one natural loop from the
 170 /// program into a function if it can.  This is used by bugpoint.
 171 ///
 172 Pass *createSingleLoopExtractorPass();
 173
 174 /// createBlockExtractorPass - This pass extracts all blocks (except those
 175 /// specified in the argument list) from the functions in the module.
 176 ///
 177 ModulePass *createBlockExtractorPass();
 178
 179 /// createStripDeadPrototypesPass - This pass removes any function declarations
 180 /// (prototypes) that are not used.
 181 ModulePass *createStripDeadPrototypesPass();
 182
 183 //===----------------------------------------------------------------------===//
 184 /// createFunctionAttrsPass - This pass discovers functions that do not access
 185 /// memory, or only read memory, and gives them the readnone/readonly attribute.
 186 /// It also discovers function arguments that are not captured by the function
 187 /// and marks them with the nocapture attribute.
 188 ///
 189 Pass *createFunctionAttrsPass();
 190
 191 //===----------------------------------------------------------------------===//
 192 /// createMergeFunctionsPass - This pass discovers identical functions and
 193 /// collapses them.
 194 ///
 195 ModulePass *createMergeFunctionsPass();
 196
 197 //===----------------------------------------------------------------------===//
 198 /// createPartialInliningPass - This pass inlines parts of functions.
 199 ///
 200 ModulePass *createPartialInliningPass();
 201
 202 } // End llvm namespace
 203
 204 #endif