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/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"
27 // Forward references to llvm classes.
36 //===----------------------------------------------------------------------===//
37 /// LTOModule - C++ class which implements the opaque lto_module_t type.
41 typedef llvm::StringMap<uint8_t> StringSet;
43 struct NameAndAttributes {
47 const llvm::GlobalValue *symbol;
50 llvm::OwningPtr<llvm::Module> _module;
51 llvm::OwningPtr<llvm::TargetMachine> _target;
52 std::vector<NameAndAttributes> _symbols;
54 // _defines and _undefines only needed to disambiguate tentative definitions
56 llvm::StringMap<NameAndAttributes> _undefines;
57 std::vector<const char*> _asm_undefines;
58 llvm::MCContext _context;
60 // Use mangler to add GlobalPrefix to names to match linker names.
61 llvm::Mangler _mangler;
63 LTOModule(llvm::Module *m, llvm::TargetMachine *t);
65 /// isBitcodeFile - Returns 'true' if the file or memory contents is LLVM
67 static bool isBitcodeFile(const void *mem, size_t length);
68 static bool isBitcodeFile(const char *path);
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,
74 const char *triplePrefix);
75 static bool isBitcodeFileForTarget(const char *path,
76 const char *triplePrefix);
78 /// makeLTOModule - Create an LTOModule. N.B. These methods take ownership
80 static LTOModule *makeLTOModule(const char* path,
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,
88 static LTOModule *makeLTOModule(const void *mem, size_t length,
91 /// getTargetTriple - Return the Module's target triple.
92 const char *getTargetTriple() {
93 return _module->getTargetTriple().c_str();
96 /// setTargetTriple - Set the Module's target triple.
97 void setTargetTriple(const char *triple) {
98 _module->setTargetTriple(triple);
101 /// getSymbolCount - Get the number of symbols
102 uint32_t getSymbolCount() {
103 return _symbols.size();
106 /// getSymbolAttributes - Get the attributes for a symbol at the specified
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);
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;
121 /// getLLVVMModule - Return the Module.
122 llvm::Module *getLLVVMModule() { return _module.get(); }
124 /// getAsmUndefinedRefs -
125 const std::vector<const char*> &getAsmUndefinedRefs() {
126 return _asm_undefines;
129 /// getTargetOptions - Fill the TargetOptions object with the options
130 /// specified on the command line.
131 static void getTargetOptions(llvm::TargetOptions &Options);
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);
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);
142 /// addDefinedSymbol - Add a defined symbol to the list.
143 void addDefinedSymbol(const llvm::GlobalValue *def, bool isFunction);
145 /// addDefinedFunctionSymbol - Add a function symbol as defined to the list.
146 void addDefinedFunctionSymbol(const llvm::Function *f);
148 /// addDefinedDataSymbol - Add a data symbol as defined to the list.
149 void addDefinedDataSymbol(const llvm::GlobalValue *v);
151 /// addAsmGlobalSymbols - Add global symbols from module-level ASM to the
152 /// defined or undefined lists.
153 bool addAsmGlobalSymbols(std::string &errMsg);
155 /// addAsmGlobalSymbol - Add a global symbol from module-level ASM to the
157 void addAsmGlobalSymbol(const char *, lto_symbol_attributes scope);
159 /// addAsmGlobalSymbolUndef - Add a global symbol from module-level ASM to
160 /// the undefined list.
161 void addAsmGlobalSymbolUndef(const char *);
163 /// addObjCClass - Parse i386/ppc ObjC class data structure.
164 void addObjCClass(const llvm::GlobalVariable *clgv);
166 /// addObjCCategory - Parse i386/ppc ObjC category data structure.
167 void addObjCCategory(const llvm::GlobalVariable *clgv);
169 /// addObjCClassRef - Parse i386/ppc ObjC class list data structure.
170 void addObjCClassRef(const llvm::GlobalVariable *clgv);
172 /// objcClassNameFromExpression - Get string that the data pointer points
174 bool objcClassNameFromExpression(const llvm::Constant* c, std::string &name);
176 /// isTargetMatch - Returns 'true' if the memory buffer is for the specified
178 static bool isTargetMatch(llvm::MemoryBuffer *memBuffer,
179 const char *triplePrefix);
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);
186 /// makeBuffer - Create a MemoryBuffer from a memory range.
187 static llvm::MemoryBuffer *makeBuffer(const void *mem, size_t length);
190 #endif // LTO_MODULE_H