include/llvm/LTO/LTOCodeGenerator.h

   1 //===-LTOCodeGenerator.h - LLVM Link Time Optimizer -----------------------===//
   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 file declares the LTOCodeGenerator class.
  11 //
  12 //   LTO compilation consists of three phases: Pre-IPO, IPO and Post-IPO.
  13 //
  14 //   The Pre-IPO phase compiles source code into bitcode file. The resulting
  15 // bitcode files, along with object files and libraries, will be fed to the
  16 // linker to through the IPO and Post-IPO phases. By using obj-file extension,
  17 // the resulting bitcode file disguises itself as an object file, and therefore
  18 // obviates the need of writing a special set of the make-rules only for LTO
  19 // compilation.
  20 //
  21 //   The IPO phase perform inter-procedural analyses and optimizations, and
  22 // the Post-IPO consists two sub-phases: intra-procedural scalar optimizations
  23 // (SOPT), and intra-procedural target-dependent code generator (CG).
  24 //
  25 //   As of this writing, we don't separate IPO and the Post-IPO SOPT. They
  26 // are intermingled together, and are driven by a single pass manager (see
  27 // PassManagerBuilder::populateLTOPassManager()).
  28 //
  29 //   The "LTOCodeGenerator" is the driver for the IPO and Post-IPO stages.
  30 // The "CodeGenerator" here is bit confusing. Don't confuse the "CodeGenerator"
  31 // with the machine specific code generator.
  32 //
  33 //===----------------------------------------------------------------------===//
  34
  35 #ifndef LLVM_LTO_LTOCODEGENERATOR_H
  36 #define LLVM_LTO_LTOCODEGENERATOR_H
  37
  38 #include "llvm-c/lto.h"
  39 #include "llvm/ADT/ArrayRef.h"
  40 #include "llvm/ADT/SmallPtrSet.h"
  41 #include "llvm/ADT/StringMap.h"
  42 #include "llvm/Linker/Linker.h"
  43 #include "llvm/Target/TargetOptions.h"
  44 #include <string>
  45 #include <vector>
  46
  47 namespace llvm {
  48   class LLVMContext;
  49   class DiagnosticInfo;
  50   class GlobalValue;
  51   class Mangler;
  52   class MemoryBuffer;
  53   class TargetLibraryInfo;
  54   class TargetMachine;
  55   class raw_ostream;
  56   class raw_pwrite_stream;
  57
  58 //===----------------------------------------------------------------------===//
  59 /// C++ class which implements the opaque lto_code_gen_t type.
  60 ///
  61 struct LTOCodeGenerator {
  62   static const char *getVersionString();
  63
  64   LTOCodeGenerator();
  65   LTOCodeGenerator(std::unique_ptr<LLVMContext> Context);
  66   ~LTOCodeGenerator();
  67
  68   // Merge given module, return true on success.
  69   bool addModule(struct LTOModule *);
  70
  71   // Set the destination module.
  72   void setModule(struct LTOModule *);
  73
  74   void setTargetOptions(TargetOptions options);
  75   void setDebugInfo(lto_debug_model);
  76   void setCodePICModel(lto_codegen_model);
  77
  78   void setCpu(const char *mCpu) { MCpu = mCpu; }
  79   void setAttr(const char *mAttr) { MAttr = mAttr; }
  80   void setOptLevel(unsigned optLevel) { OptLevel = optLevel; }
  81
  82   void setShouldInternalize(bool Value) { ShouldInternalize = Value; }
  83
  84   void addMustPreserveSymbol(const char *sym) { MustPreserveSymbols[sym] = 1; }
  85
  86   // To pass options to the driver and optimization passes. These options are
  87   // not necessarily for debugging purpose (The function name is misleading).
  88   // This function should be called before LTOCodeGenerator::compilexxx(),
  89   // and LTOCodeGenerator::writeMergedModules().
  90   void setCodeGenDebugOptions(const char *opts);
  91
  92   // Parse the options set in setCodeGenDebugOptions. Like
  93   // setCodeGenDebugOptions, this must be called before
  94   // LTOCodeGenerator::compilexxx() and LTOCodeGenerator::writeMergedModules()
  95   void parseCodeGenDebugOptions();
  96
  97   // Write the merged module to the file specified by the given path.
  98   // Return true on success.
  99   bool writeMergedModules(const char *path, std::string &errMsg);
 100
 101   // Compile the merged module into a *single* object file; the path to object
 102   // file is returned to the caller via argument "name". Return true on
 103   // success.
 104   //
 105   // NOTE that it is up to the linker to remove the intermediate object file.
 106   //  Do not try to remove the object file in LTOCodeGenerator's destructor
 107   //  as we don't who (LTOCodeGenerator or the obj file) will last longer.
 108   bool compile_to_file(const char **name,
 109                        bool disableInline,
 110                        bool disableGVNLoadPRE,
 111                        bool disableVectorization,
 112                        std::string &errMsg);
 113
 114   // As with compile_to_file(), this function compiles the merged module into
 115   // single object file. Instead of returning the object-file-path to the caller
 116   // (linker), it brings the object to a buffer, and return the buffer to the
 117   // caller. This function should delete intermediate object file once its content
 118   // is brought to memory. Return NULL if the compilation was not successful.
 119   const void *compile(size_t *length,
 120                       bool disableInline,
 121                       bool disableGVNLoadPRE,
 122                       bool disableVectorization,
 123                       std::string &errMsg);
 124
 125   // Optimizes the merged module. Returns true on success.
 126   bool optimize(bool disableInline,
 127                 bool disableGVNLoadPRE,
 128                 bool disableVectorization,
 129                 std::string &errMsg);
 130
 131   // Compiles the merged optimized module into a single object file. It brings
 132   // the object to a buffer, and returns the buffer to the caller. Return NULL
 133   // if the compilation was not successful.
 134   const void *compileOptimized(size_t *length, std::string &errMsg);
 135
 136   void setDiagnosticHandler(lto_diagnostic_handler_t, void *);
 137
 138   LLVMContext &getContext() { return Context; }
 139
 140 private:
 141   void initializeLTOPasses();
 142
 143   bool compileOptimized(raw_pwrite_stream &out, std::string &errMsg);
 144   bool compileOptimizedToFile(const char **name, std::string &errMsg);
 145   void applyScopeRestrictions();
 146   void applyRestriction(GlobalValue &GV, ArrayRef<StringRef> Libcalls,
 147                         std::vector<const char *> &MustPreserveList,
 148                         SmallPtrSetImpl<GlobalValue *> &AsmUsed,
 149                         Mangler &Mangler);
 150   bool determineTarget(std::string &errMsg);
 151
 152   static void DiagnosticHandler(const DiagnosticInfo &DI, void *Context);
 153
 154   void DiagnosticHandler2(const DiagnosticInfo &DI);
 155
 156   typedef StringMap<uint8_t> StringSet;
 157
 158   void destroyMergedModule();
 159   std::unique_ptr<LLVMContext> OwnedContext;
 160   LLVMContext &Context;
 161   Linker IRLinker;
 162   TargetMachine *TargetMach = nullptr;
 163   bool EmitDwarfDebugInfo = false;
 164   bool ScopeRestrictionsDone = false;
 165   lto_codegen_model CodeModel = LTO_CODEGEN_PIC_MODEL_DEFAULT;
 166   StringSet MustPreserveSymbols;
 167   StringSet AsmUndefinedRefs;
 168   std::unique_ptr<MemoryBuffer> NativeObjectFile;
 169   std::vector<char *> CodegenOptions;
 170   std::string MCpu;
 171   std::string MAttr;
 172   std::string NativeObjectPath;
 173   TargetOptions Options;
 174   unsigned OptLevel = 2;
 175   lto_diagnostic_handler_t DiagHandler = nullptr;
 176   void *DiagContext = nullptr;
 177   LTOModule *OwnedModule = nullptr;
 178   bool ShouldInternalize = true;
 179 };
 180 }
 181 #endif