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.
28namespace 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///
39struct LTOModule {
40private:
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);
64public:
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. The caller must have initialized the Targets, the
80  /// TargetMCs, the AsmPrinters, and the AsmParsers by calling:
81  ///
82  /// InitializeAllTargets();
83  /// InitializeAllTargetMCs();
84  /// InitializeAllAsmPrinters();
85  /// InitializeAllAsmParsers();
86  static LTOModule *makeLTOModule(const char* path,
87                                  llvm::TargetOptions options,
88                                  std::string &errMsg);
89  static LTOModule *makeLTOModule(int fd, const char *path,
90                                  size_t size, llvm::TargetOptions options,
91                                  std::string &errMsg);
92  static LTOModule *makeLTOModule(int fd, const char *path,
93                                  size_t map_size,
94                                  off_t offset, llvm::TargetOptions options,
95                                  std::string& errMsg);
96  static LTOModule *makeLTOModule(const void *mem, size_t length,
97                                  llvm::TargetOptions options,
98                                  std::string &errMsg);
99
100  /// getTargetTriple - Return the Module's target triple.
101  const char *getTargetTriple() {
102    return _module->getTargetTriple().c_str();
103  }
104
105  /// setTargetTriple - Set the Module's target triple.
106  void setTargetTriple(const char *triple) {
107    _module->setTargetTriple(triple);
108  }
109
110  /// getSymbolCount - Get the number of symbols
111  uint32_t getSymbolCount() {
112    return _symbols.size();
113  }
114
115  /// getSymbolAttributes - Get the attributes for a symbol at the specified
116  /// index.
117  lto_symbol_attributes getSymbolAttributes(uint32_t index) {
118    if (index < _symbols.size())
119      return lto_symbol_attributes(_symbols[index].attributes);
120    return lto_symbol_attributes(0);
121  }
122
123  /// getSymbolName - Get the name of the symbol at the specified index.
124  const char *getSymbolName(uint32_t index) {
125    if (index < _symbols.size())
126      return _symbols[index].name;
127    return NULL;
128  }
129
130  /// getLLVVMModule - Return the Module.
131  llvm::Module *getLLVVMModule() { return _module.get(); }
132
133  /// getAsmUndefinedRefs -
134  const std::vector<const char*> &getAsmUndefinedRefs() {
135    return _asm_undefines;
136  }
137
138private:
139  /// parseSymbols - Parse the symbols from the module and model-level ASM and
140  /// add them to either the defined or undefined lists.
141  bool parseSymbols(std::string &errMsg);
142
143  /// addPotentialUndefinedSymbol - Add a symbol which isn't defined just yet
144  /// to a list to be resolved later.
145  void addPotentialUndefinedSymbol(const llvm::GlobalValue *dcl, bool isFunc);
146
147  /// addDefinedSymbol - Add a defined symbol to the list.
148  void addDefinedSymbol(const llvm::GlobalValue *def, bool isFunction);
149
150  /// addDefinedFunctionSymbol - Add a function symbol as defined to the list.
151  void addDefinedFunctionSymbol(const llvm::Function *f);
152
153  /// addDefinedDataSymbol - Add a data symbol as defined to the list.
154  void addDefinedDataSymbol(const llvm::GlobalValue *v);
155
156  /// addAsmGlobalSymbols - Add global symbols from module-level ASM to the
157  /// defined or undefined lists.
158  bool addAsmGlobalSymbols(std::string &errMsg);
159
160  /// addAsmGlobalSymbol - Add a global symbol from module-level ASM to the
161  /// defined list.
162  void addAsmGlobalSymbol(const char *, lto_symbol_attributes scope);
163
164  /// addAsmGlobalSymbolUndef - Add a global symbol from module-level ASM to
165  /// the undefined list.
166  void addAsmGlobalSymbolUndef(const char *);
167
168  /// addObjCClass - Parse i386/ppc ObjC class data structure.
169  void addObjCClass(const llvm::GlobalVariable *clgv);
170
171  /// addObjCCategory - Parse i386/ppc ObjC category data structure.
172  void addObjCCategory(const llvm::GlobalVariable *clgv);
173
174  /// addObjCClassRef - Parse i386/ppc ObjC class list data structure.
175  void addObjCClassRef(const llvm::GlobalVariable *clgv);
176
177  /// objcClassNameFromExpression - Get string that the data pointer points
178  /// to.
179  bool objcClassNameFromExpression(const llvm::Constant* c, std::string &name);
180
181  /// isTargetMatch - Returns 'true' if the memory buffer is for the specified
182  /// target triple.
183  static bool isTargetMatch(llvm::MemoryBuffer *memBuffer,
184                            const char *triplePrefix);
185
186  /// makeLTOModule - Create an LTOModule (private version). N.B. This
187  /// method takes ownership of the buffer.
188  static LTOModule *makeLTOModule(llvm::MemoryBuffer *buffer,
189                                  llvm::TargetOptions options,
190                                  std::string &errMsg);
191
192  /// makeBuffer - Create a MemoryBuffer from a memory range.
193  static llvm::MemoryBuffer *makeBuffer(const void *mem, size_t length);
194};
195
196#endif // LTO_MODULE_H
197