1 //===-LTOModule.h - LLVM Link Time Optimizer ------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the LTOModule class.
12 //===----------------------------------------------------------------------===//
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"
27 // Forward references to llvm classes.
35 //===----------------------------------------------------------------------===//
36 /// C++ class which implements the opaque lto_module_t type.
40 typedef StringMap<uint8_t> StringSet;
42 struct NameAndAttributes {
46 const GlobalValue *symbol;
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;
57 // _defines and _undefines only needed to disambiguate tentative definitions
59 StringMap<NameAndAttributes> _undefines;
60 std::vector<const char*> _asm_undefines;
63 // Use mangler to add GlobalPrefix to names to match linker names.
66 LTOModule(std::unique_ptr<Module> M, TargetMachine *TM);
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);
73 /// Returns 'true' if the file or memory contents is LLVM bitcode for the
75 static bool isBitcodeFileForTarget(const void *mem,
77 const char *triplePrefix);
78 static bool isBitcodeFileForTarget(const char *path,
79 const char *triplePrefix);
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:
85 /// InitializeAllTargets();
86 /// InitializeAllTargetMCs();
87 /// InitializeAllAsmPrinters();
88 /// InitializeAllAsmParsers();
89 static LTOModule *makeLTOModule(const char *path, TargetOptions options,
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,
96 static LTOModule *makeLTOModule(const void *mem, size_t length,
97 TargetOptions options, std::string &errMsg,
100 /// Return the Module's target triple.
101 const char *getTargetTriple() {
102 return _module->getTargetTriple().c_str();
105 /// Set the Module's target triple.
106 void setTargetTriple(const char *triple) {
107 _module->setTargetTriple(triple);
110 /// Get the number of symbols
111 uint32_t getSymbolCount() {
112 return _symbols.size();
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);
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;
129 /// Get the number of dependent libraries
130 uint32_t getDependentLibraryCount() {
131 return _deplibs.size();
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];
141 /// Get the number of linker options
142 uint32_t getLinkerOptCount() {
143 return _linkeropts.size();
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];
153 /// Return the Module.
154 Module *getLLVVMModule() { return _module.get(); }
156 const std::vector<const char*> &getAsmUndefinedRefs() {
157 return _asm_undefines;
161 /// Parse metadata from the module
162 // FIXME: it only parses "Linker Options" metadata at the moment
163 void parseMetadata();
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);
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);
172 /// Add a defined symbol to the list.
173 void addDefinedSymbol(const GlobalValue *def, bool isFunction);
175 /// Add a function symbol as defined to the list.
176 void addDefinedFunctionSymbol(const Function *f);
178 /// Add a data symbol as defined to the list.
179 void addDefinedDataSymbol(const GlobalValue *v);
181 /// Add global symbols from module-level ASM to the defined or undefined
183 bool addAsmGlobalSymbols(std::string &errMsg);
185 /// Add a global symbol from module-level ASM to the defined list.
186 void addAsmGlobalSymbol(const char *, lto_symbol_attributes scope);
188 /// Add a global symbol from module-level ASM to the undefined list.
189 void addAsmGlobalSymbolUndef(const char *);
191 /// Parse i386/ppc ObjC class data structure.
192 void addObjCClass(const GlobalVariable *clgv);
194 /// Parse i386/ppc ObjC category data structure.
195 void addObjCCategory(const GlobalVariable *clgv);
197 /// Parse i386/ppc ObjC class list data structure.
198 void addObjCClassRef(const GlobalVariable *clgv);
200 /// Get string that the data pointer points to.
201 bool objcClassNameFromExpression(const Constant *c, std::string &name);
203 /// Returns 'true' if the memory buffer is for the specified target triple.
204 static bool isTargetMatch(MemoryBuffer *memBuffer, const char *triplePrefix);
206 /// Create an LTOModule (private version). N.B. This method takes ownership of
208 static LTOModule *makeLTOModule(std::unique_ptr<MemoryBuffer> Buffer,
209 TargetOptions options, std::string &errMsg);
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 = "");
216 #endif // LTO_MODULE_H