tools/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/OwningPtr.h"
  19 #include "llvm/ADT/StringMap.h"
  20 #include "llvm/IR/Module.h"
  21 #include "llvm/MC/MCContext.h"
  22 #include "llvm/Target/Mangler.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 //===----------------------------------------------------------------------===//
  37 /// LTOModule - C++ class which implements the opaque lto_module_t type.
  38 ///
  39 struct LTOModule {
  40 private:
  41   typedef llvm::StringMap<uint8_t> StringSet;
  42
  43   struct NameAndAttributes {
  44     const char        *name;
  45     uint32_t           attributes;
  46     bool               isFunction;
  47     const llvm::GlobalValue *symbol;
  48   };
  49
  50   llvm::OwningPtr<llvm::Module>           _module;
  51   llvm::OwningPtr<llvm::TargetMachine>    _target;
  52   std::vector<NameAndAttributes>          _symbols;
  53
  54   // _defines and _undefines only needed to disambiguate tentative definitions
  55   StringSet                               _defines;
  56   llvm::StringMap<NameAndAttributes>      _undefines;
  57   std::vector<const char*>                _asm_undefines;
  58   llvm::MCContext                         _context;
  59
  60   // Use mangler to add GlobalPrefix to names to match linker names.
  61   llvm::Mangler                           _mangler;
  62
  63   LTOModule(llvm::Module *m, llvm::TargetMachine *t);
  64 public:
  65   /// isBitcodeFile - Returns 'true' if the file or memory contents is LLVM
  66   /// bitcode.
  67   static bool isBitcodeFile(const void *mem, size_t length);
  68   static bool isBitcodeFile(const char *path);
  69
  70   /// isBitcodeFileForTarget - Returns 'true' if the file or memory contents
  71   /// is LLVM bitcode for the specified triple.
  72   static bool isBitcodeFileForTarget(const void *mem,
  73                                      size_t length,
  74                                      const char *triplePrefix);
  75   static bool isBitcodeFileForTarget(const char *path,
  76                                      const char *triplePrefix);
  77
  78   /// makeLTOModule - Create an LTOModule. N.B. These methods take ownership
  79   /// of the buffer.
  80   static LTOModule *makeLTOModule(const char* path,
  81                                   std::string &errMsg);
  82   static LTOModule *makeLTOModule(int fd, const char *path,
  83                                   size_t size, std::string &errMsg);
  84   static LTOModule *makeLTOModule(int fd, const char *path,
  85                                   size_t map_size,
  86                                   off_t offset,
  87                                   std::string& errMsg);
  88   static LTOModule *makeLTOModule(const void *mem, size_t length,
  89                                   std::string &errMsg);
  90
  91   /// getTargetTriple - Return the Module's target triple.
  92   const char *getTargetTriple() {
  93     return _module->getTargetTriple().c_str();
  94   }
  95
  96   /// setTargetTriple - Set the Module's target triple.
  97   void setTargetTriple(const char *triple) {
  98     _module->setTargetTriple(triple);
  99   }
 100
 101   /// getSymbolCount - Get the number of symbols
 102   uint32_t getSymbolCount() {
 103     return _symbols.size();
 104   }
 105
 106   /// getSymbolAttributes - Get the attributes for a symbol at the specified
 107   /// index.
 108   lto_symbol_attributes getSymbolAttributes(uint32_t index) {
 109     if (index < _symbols.size())
 110       return lto_symbol_attributes(_symbols[index].attributes);
 111     return lto_symbol_attributes(0);
 112   }
 113
 114   /// getSymbolName - Get the name of the symbol at the specified index.
 115   const char *getSymbolName(uint32_t index) {
 116     if (index < _symbols.size())
 117       return _symbols[index].name;
 118     return NULL;
 119   }
 120
 121   /// getLLVVMModule - Return the Module.
 122   llvm::Module *getLLVVMModule() { return _module.get(); }
 123
 124   /// getAsmUndefinedRefs -
 125   const std::vector<const char*> &getAsmUndefinedRefs() {
 126     return _asm_undefines;
 127   }
 128
 129   /// getTargetOptions - Fill the TargetOptions object with the options
 130   /// specified on the command line.
 131   static void getTargetOptions(llvm::TargetOptions &Options);
 132
 133 private:
 134   /// parseSymbols - Parse the symbols from the module and model-level ASM and
 135   /// add them to either the defined or undefined lists.
 136   bool parseSymbols(std::string &errMsg);
 137
 138   /// addPotentialUndefinedSymbol - Add a symbol which isn't defined just yet
 139   /// to a list to be resolved later.
 140   void addPotentialUndefinedSymbol(const llvm::GlobalValue *dcl, bool isFunc);
 141
 142   /// addDefinedSymbol - Add a defined symbol to the list.
 143   void addDefinedSymbol(const llvm::GlobalValue *def, bool isFunction);
 144
 145   /// addDefinedFunctionSymbol - Add a function symbol as defined to the list.
 146   void addDefinedFunctionSymbol(const llvm::Function *f);
 147
 148   /// addDefinedDataSymbol - Add a data symbol as defined to the list.
 149   void addDefinedDataSymbol(const llvm::GlobalValue *v);
 150
 151   /// addAsmGlobalSymbols - Add global symbols from module-level ASM to the
 152   /// defined or undefined lists.
 153   bool addAsmGlobalSymbols(std::string &errMsg);
 154
 155   /// addAsmGlobalSymbol - Add a global symbol from module-level ASM to the
 156   /// defined list.
 157   void addAsmGlobalSymbol(const char *, lto_symbol_attributes scope);
 158
 159   /// addAsmGlobalSymbolUndef - Add a global symbol from module-level ASM to
 160   /// the undefined list.
 161   void addAsmGlobalSymbolUndef(const char *);
 162
 163   /// addObjCClass - Parse i386/ppc ObjC class data structure.
 164   void addObjCClass(const llvm::GlobalVariable *clgv);
 165
 166   /// addObjCCategory - Parse i386/ppc ObjC category data structure.
 167   void addObjCCategory(const llvm::GlobalVariable *clgv);
 168
 169   /// addObjCClassRef - Parse i386/ppc ObjC class list data structure.
 170   void addObjCClassRef(const llvm::GlobalVariable *clgv);
 171
 172   /// objcClassNameFromExpression - Get string that the data pointer points
 173   /// to.
 174   bool objcClassNameFromExpression(const llvm::Constant* c, std::string &name);
 175
 176   /// isTargetMatch - Returns 'true' if the memory buffer is for the specified
 177   /// target triple.
 178   static bool isTargetMatch(llvm::MemoryBuffer *memBuffer,
 179                             const char *triplePrefix);
 180
 181   /// makeLTOModule - Create an LTOModule (private version). N.B. This
 182   /// method takes ownership of the buffer.
 183   static LTOModule *makeLTOModule(llvm::MemoryBuffer *buffer,
 184                                   std::string &errMsg);
 185
 186   /// makeBuffer - Create a MemoryBuffer from a memory range.
 187   static llvm::MemoryBuffer *makeBuffer(const void *mem, size_t length);
 188 };
 189
 190 #endif // LTO_MODULE_H