include/llvm/LTO/LTOModule.h

   1 //===-LTOModule.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 LTOModule class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LTO_MODULE_H
  15 #define LTO_MODULE_H
  16
  17 #include "llvm-c/lto.h"
  18 #include "llvm/ADT/StringMap.h"
  19 #include "llvm/IR/Mangler.h"
  20 #include "llvm/IR/Module.h"
  21 #include "llvm/MC/MCContext.h"
  22 #include "llvm/MC/MCObjectFileInfo.h"
  23 #include "llvm/Target/TargetMachine.h"
  24 #include <string>
  25 #include <vector>
  26
  27 // Forward references to llvm classes.
  28 namespace llvm {
  29   class Function;
  30   class GlobalValue;
  31   class MemoryBuffer;
  32   class TargetOptions;
  33   class Value;
  34
  35 //===----------------------------------------------------------------------===//
  36 /// C++ class which implements the opaque lto_module_t type.
  37 ///
  38 struct LTOModule {
  39 private:
  40   typedef StringMap<uint8_t> StringSet;
  41
  42   struct NameAndAttributes {
  43     const char        *name;
  44     uint32_t           attributes;
  45     bool               isFunction;
  46     const GlobalValue *symbol;
  47   };
  48
  49   std::unique_ptr<Module> _module;
  50   std::unique_ptr<TargetMachine> _target;
  51   MCObjectFileInfo ObjFileInfo;
  52   StringSet                               _linkeropt_strings;
  53   std::vector<const char *>               _deplibs;
  54   std::vector<const char *>               _linkeropts;
  55   std::vector<NameAndAttributes>          _symbols;
  56
  57   // _defines and _undefines only needed to disambiguate tentative definitions
  58   StringSet                               _defines;
  59   StringMap<NameAndAttributes> _undefines;
  60   std::vector<const char*>                _asm_undefines;
  61   MCContext _context;
  62
  63   // Use mangler to add GlobalPrefix to names to match linker names.
  64   Mangler _mangler;
  65
  66   LTOModule(std::unique_ptr<Module> M, TargetMachine *TM);
  67
  68 public:
  69   /// Returns 'true' if the file or memory contents is LLVM bitcode.
  70   static bool isBitcodeFile(const void *mem, size_t length);
  71   static bool isBitcodeFile(const char *path);
  72
  73   /// Returns 'true' if the file or memory contents is LLVM bitcode for the
  74   /// specified triple.
  75   static bool isBitcodeFileForTarget(const void *mem,
  76                                      size_t length,
  77                                      const char *triplePrefix);
  78   static bool isBitcodeFileForTarget(const char *path,
  79                                      const char *triplePrefix);
  80
  81   /// Create an LTOModule. N.B. These methods take ownership of the buffer. The
  82   /// caller must have initialized the Targets, the TargetMCs, the AsmPrinters,
  83   /// and the AsmParsers by calling:
  84   ///
  85   /// InitializeAllTargets();
  86   /// InitializeAllTargetMCs();
  87   /// InitializeAllAsmPrinters();
  88   /// InitializeAllAsmParsers();
  89   static LTOModule *makeLTOModule(const char *path, TargetOptions options,
  90                                   std::string &errMsg);
  91   static LTOModule *makeLTOModule(int fd, const char *path, size_t size,
  92                                   TargetOptions options, std::string &errMsg);
  93   static LTOModule *makeLTOModule(int fd, const char *path, size_t map_size,
  94                                   off_t offset, TargetOptions options,
  95                                   std::string &errMsg);
  96   static LTOModule *makeLTOModule(const void *mem, size_t length,
  97                                   TargetOptions options, std::string &errMsg,
  98                                   StringRef path = "");
  99
 100   /// Return the Module's target triple.
 101   const char *getTargetTriple() {
 102     return _module->getTargetTriple().c_str();
 103   }
 104
 105   /// Set the Module's target triple.
 106   void setTargetTriple(const char *triple) {
 107     _module->setTargetTriple(triple);
 108   }
 109
 110   /// Get the number of symbols
 111   uint32_t getSymbolCount() {
 112     return _symbols.size();
 113   }
 114
 115   /// Get the attributes for a symbol at the specified index.
 116   lto_symbol_attributes getSymbolAttributes(uint32_t index) {
 117     if (index < _symbols.size())
 118       return lto_symbol_attributes(_symbols[index].attributes);
 119     return lto_symbol_attributes(0);
 120   }
 121
 122   /// Get the name of the symbol at the specified index.
 123   const char *getSymbolName(uint32_t index) {
 124     if (index < _symbols.size())
 125       return _symbols[index].name;
 126     return nullptr;
 127   }
 128
 129   /// Get the number of dependent libraries
 130   uint32_t getDependentLibraryCount() {
 131     return _deplibs.size();
 132   }
 133
 134   /// Get the dependent library at the specified index.
 135   const char *getDependentLibrary(uint32_t index) {
 136     if (index < _deplibs.size())
 137       return _deplibs[index];
 138     return nullptr;
 139   }
 140
 141   /// Get the number of linker options
 142   uint32_t getLinkerOptCount() {
 143     return _linkeropts.size();
 144   }
 145
 146   /// Get the linker option at the specified index.
 147   const char *getLinkerOpt(uint32_t index) {
 148     if (index < _linkeropts.size())
 149       return _linkeropts[index];
 150     return nullptr;
 151   }
 152
 153   /// Return the Module.
 154   Module *getLLVVMModule() { return _module.get(); }
 155
 156   const std::vector<const char*> &getAsmUndefinedRefs() {
 157     return _asm_undefines;
 158   }
 159
 160 private:
 161   /// Parse metadata from the module
 162   // FIXME: it only parses "Linker Options" metadata at the moment
 163   void parseMetadata();
 164
 165   /// Parse the symbols from the module and model-level ASM and add them to
 166   /// either the defined or undefined lists.
 167   bool parseSymbols(std::string &errMsg);
 168
 169   /// Add a symbol which isn't defined just yet to a list to be resolved later.
 170   void addPotentialUndefinedSymbol(const GlobalValue *dcl, bool isFunc);
 171
 172   /// Add a defined symbol to the list.
 173   void addDefinedSymbol(const GlobalValue *def, bool isFunction);
 174
 175   /// Add a function symbol as defined to the list.
 176   void addDefinedFunctionSymbol(const Function *f);
 177
 178   /// Add a data symbol as defined to the list.
 179   void addDefinedDataSymbol(const GlobalValue *v);
 180
 181   /// Add global symbols from module-level ASM to the defined or undefined
 182   /// lists.
 183   bool addAsmGlobalSymbols(std::string &errMsg);
 184
 185   /// Add a global symbol from module-level ASM to the defined list.
 186   void addAsmGlobalSymbol(const char *, lto_symbol_attributes scope);
 187
 188   /// Add a global symbol from module-level ASM to the undefined list.
 189   void addAsmGlobalSymbolUndef(const char *);
 190
 191   /// Parse i386/ppc ObjC class data structure.
 192   void addObjCClass(const GlobalVariable *clgv);
 193
 194   /// Parse i386/ppc ObjC category data structure.
 195   void addObjCCategory(const GlobalVariable *clgv);
 196
 197   /// Parse i386/ppc ObjC class list data structure.
 198   void addObjCClassRef(const GlobalVariable *clgv);
 199
 200   /// Get string that the data pointer points to.
 201   bool objcClassNameFromExpression(const Constant *c, std::string &name);
 202
 203   /// Returns 'true' if the memory buffer is for the specified target triple.
 204   static bool isTargetMatch(MemoryBuffer *memBuffer, const char *triplePrefix);
 205
 206   /// Create an LTOModule (private version). N.B. This method takes ownership of
 207   /// the buffer.
 208   static LTOModule *makeLTOModule(std::unique_ptr<MemoryBuffer> Buffer,
 209                                   TargetOptions options, std::string &errMsg);
 210
 211   /// Create a MemoryBuffer from a memory range with an optional name.
 212   static MemoryBuffer *makeBuffer(const void *mem, size_t length,
 213                                   StringRef name = "");
 214 };
 215 }
 216 #endif // LTO_MODULE_H