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/Target/TargetMachine.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 Linker;
  52   class Mangler;
  53   class MemoryBuffer;
  54   class TargetLibraryInfo;
  55   class TargetMachine;
  56   class raw_ostream;
  57   class raw_pwrite_stream;
  58
  59 //===----------------------------------------------------------------------===//
  60 /// C++ class which implements the opaque lto_code_gen_t type.
  61 ///
  62 struct LTOCodeGenerator {
  63   static const char *getVersionString();
  64
  65   LTOCodeGenerator(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(std::unique_ptr<LTOModule> M);
  73
  74   void setTargetOptions(TargetOptions Options);
  75   void setDebugInfo(lto_debug_model);
  76   void setCodePICModel(Reloc::Model Model) { RelocModel = Model; }
  77
  78   /// Set the file type to be emitted (assembly or object code).
  79   /// The default is TargetMachine::CGFT_ObjectFile.
  80   void setFileType(TargetMachine::CodeGenFileType FT) { FileType = FT; }
  81
  82   void setCpu(const char *MCpu) { this->MCpu = MCpu; }
  83   void setAttr(const char *MAttr) { this->MAttr = MAttr; }
  84   void setOptLevel(unsigned OptLevel);
  85
  86   void setShouldInternalize(bool Value) { ShouldInternalize = Value; }
  87   void setShouldEmbedUselists(bool Value) { ShouldEmbedUselists = Value; }
  88
  89   void addMustPreserveSymbol(StringRef Sym) { MustPreserveSymbols[Sym] = 1; }
  90
  91   /// Pass options to the driver and optimization passes.
  92   ///
  93   /// These options are not necessarily for debugging purpose (the function
  94   /// name is misleading).  This function should be called before
  95   /// LTOCodeGenerator::compilexxx(), and
  96   /// LTOCodeGenerator::writeMergedModules().
  97   void setCodeGenDebugOptions(const char *Opts);
  98
  99   /// Parse the options set in setCodeGenDebugOptions.
 100   ///
 101   /// Like \a setCodeGenDebugOptions(), this must be called before
 102   /// LTOCodeGenerator::compilexxx() and
 103   /// LTOCodeGenerator::writeMergedModules().
 104   void parseCodeGenDebugOptions();
 105
 106   /// Write the merged module to the file specified by the given path.  Return
 107   /// true on success.
 108   bool writeMergedModules(const char *Path);
 109
 110   /// Compile the merged module into a *single* output file; the path to output
 111   /// file is returned to the caller via argument "name". Return true on
 112   /// success.
 113   ///
 114   /// \note It is up to the linker to remove the intermediate output file.  Do
 115   /// not try to remove the object file in LTOCodeGenerator's destructor as we
 116   /// don't who (LTOCodeGenerator or the output file) will last longer.
 117   bool compile_to_file(const char **Name, bool DisableVerify,
 118                        bool DisableInline, bool DisableGVNLoadPRE,
 119                        bool DisableVectorization);
 120
 121   /// As with compile_to_file(), this function compiles the merged module into
 122   /// single output file. Instead of returning the output file path to the
 123   /// caller (linker), it brings the output to a buffer, and returns the buffer
 124   /// to the caller. This function should delete the intermediate file once
 125   /// its content is brought to memory. Return NULL if the compilation was not
 126   /// successful.
 127   std::unique_ptr<MemoryBuffer> compile(bool DisableVerify, bool DisableInline,
 128                                         bool DisableGVNLoadPRE,
 129                                         bool DisableVectorization);
 130
 131   /// Optimizes the merged module.  Returns true on success.
 132   bool optimize(bool DisableVerify, bool DisableInline, bool DisableGVNLoadPRE,
 133                 bool DisableVectorization);
 134
 135   /// Compiles the merged optimized module into a single output file. It brings
 136   /// the output to a buffer, and returns the buffer to the caller. Return NULL
 137   /// if the compilation was not successful.
 138   std::unique_ptr<MemoryBuffer> compileOptimized();
 139
 140   /// Compile the merged optimized module into out.size() output files each
 141   /// representing a linkable partition of the module. If out contains more
 142   /// than one element, code generation is done in parallel with out.size()
 143   /// threads.  Output files will be written to members of out. Returns true on
 144   /// success.
 145   bool compileOptimized(ArrayRef<raw_pwrite_stream *> Out);
 146
 147   void setDiagnosticHandler(lto_diagnostic_handler_t, void *);
 148
 149   LLVMContext &getContext() { return Context; }
 150
 151 private:
 152   void initializeLTOPasses();
 153
 154   bool compileOptimizedToFile(const char **Name);
 155   void applyScopeRestrictions();
 156   void applyRestriction(GlobalValue &GV, ArrayRef<StringRef> Libcalls,
 157                         std::vector<const char *> &MustPreserveList,
 158                         SmallPtrSetImpl<GlobalValue *> &AsmUsed,
 159                         Mangler &Mangler);
 160   bool determineTarget();
 161
 162   static void DiagnosticHandler(const DiagnosticInfo &DI, void *Context);
 163
 164   void DiagnosticHandler2(const DiagnosticInfo &DI);
 165
 166   void emitError(const std::string &ErrMsg);
 167
 168   typedef StringMap<uint8_t> StringSet;
 169
 170   LLVMContext &Context;
 171   std::unique_ptr<Module> MergedModule;
 172   std::unique_ptr<Linker> IRLinker;
 173   std::unique_ptr<TargetMachine> TargetMach;
 174   bool EmitDwarfDebugInfo = false;
 175   bool ScopeRestrictionsDone = false;
 176   Reloc::Model RelocModel = Reloc::Default;
 177   StringSet MustPreserveSymbols;
 178   StringSet AsmUndefinedRefs;
 179   std::vector<std::string> CodegenOptions;
 180   std::string FeatureStr;
 181   std::string MCpu;
 182   std::string MAttr;
 183   std::string NativeObjectPath;
 184   TargetOptions Options;
 185   CodeGenOpt::Level CGOptLevel = CodeGenOpt::Default;
 186   unsigned OptLevel = 2;
 187   lto_diagnostic_handler_t DiagHandler = nullptr;
 188   void *DiagContext = nullptr;
 189   bool ShouldInternalize = true;
 190   bool ShouldEmbedUselists = false;
 191   TargetMachine::CodeGenFileType FileType = TargetMachine::CGFT_ObjectFile;
 192 };
 193 }
 194 #endif