LTOModule.h revision 24b878031d4f62baf0e9a0573aeebc9dfd54b546
177595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik//===-LTOModule.h - LLVM Link Time Optimizer ------------------------------===// 277595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik// 377595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik// The LLVM Compiler Infrastructure 477595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik// 577595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik// This file is distributed under the University of Illinois Open Source 677595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik// License. See LICENSE.TXT for details. 73c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling// 877595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik//===----------------------------------------------------------------------===// 977595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik// 103c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling// This file declares the LTOModule class. 1177595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik// 1277595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik//===----------------------------------------------------------------------===// 1377595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik 1477595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik#ifndef LTO_MODULE_H 1577595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik#define LTO_MODULE_H 1677595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik 1777595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik#include "llvm/Module.h" 18b9bff969e96a24da18d6c5d0d623a7d790d41fa2Bill Wendling#include "llvm/MC/MCContext.h" 19a7280fd61933f1268f69045cfbea46edb739726dBill Wendling#include "llvm/Target/Mangler.h" 2077595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik#include "llvm/Target/TargetMachine.h" 21b9bff969e96a24da18d6c5d0d623a7d790d41fa2Bill Wendling#include "llvm/ADT/OwningPtr.h" 2277595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik#include "llvm/ADT/StringMap.h" 2377595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik 2477595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik#include "llvm-c/lto.h" 2577595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik 2677595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik#include <vector> 27ef194ed74033eba099f4f391ffdfc176f9aa6f26Nick Kledzik#include <string> 28ef194ed74033eba099f4f391ffdfc176f9aa6f26Nick Kledzik 29ef194ed74033eba099f4f391ffdfc176f9aa6f26Nick Kledzik 303bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling// Forward references to llvm classes. 31ef194ed74033eba099f4f391ffdfc176f9aa6f26Nick Kledziknamespace llvm { 3262cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling class Function; 3330fe94ea43bd122fb4fd26b84bcf62f8096d4293Bill Wendling class GlobalValue; 3462cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling class MemoryBuffer; 3530fe94ea43bd122fb4fd26b84bcf62f8096d4293Bill Wendling class Value; 36ef194ed74033eba099f4f391ffdfc176f9aa6f26Nick Kledzik} 3777595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik 3877595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik// 393bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling// C++ class which implements the opaque lto_module_t type. 4077595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik// 411f291059b26350bd96d7723d28a35734fe0a1484Douglas Gregorstruct LTOModule { 4262cf01e4c5de703e7712c72d12f577153b373cbaBill Wendlingprivate: 433bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling typedef llvm::StringMap<uint8_t> StringSet; 443c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling 453c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling struct NameAndAttributes { 4624b878031d4f62baf0e9a0573aeebc9dfd54b546Bill Wendling const char *name; 4724b878031d4f62baf0e9a0573aeebc9dfd54b546Bill Wendling uint32_t attributes; 4824b878031d4f62baf0e9a0573aeebc9dfd54b546Bill Wendling bool isFunction; 4924b878031d4f62baf0e9a0573aeebc9dfd54b546Bill Wendling llvm::GlobalValue *symbol; 503bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling }; 513bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 523bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling llvm::OwningPtr<llvm::Module> _module; 533bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling llvm::OwningPtr<llvm::TargetMachine> _target; 543bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling std::vector<NameAndAttributes> _symbols; 553bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 563bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling // _defines and _undefines only needed to disambiguate tentative definitions 573c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling StringSet _defines; 583bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling llvm::StringMap<NameAndAttributes> _undefines; 593bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling std::vector<const char*> _asm_undefines; 603bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling llvm::MCContext _context; 613bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 623bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling // Use mangler to add GlobalPrefix to names to match linker names. 633bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling llvm::Mangler _mangler; 643bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 653bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling LTOModule(llvm::Module *m, llvm::TargetMachine *t); 6662cf01e4c5de703e7712c72d12f577153b373cbaBill Wendlingpublic: 673bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// isBitcodeFile - Returns 'true' if the file or memory contents is LLVM 683bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// bitcode. 693bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling static bool isBitcodeFile(const void *mem, size_t length); 703bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling static bool isBitcodeFile(const char *path); 713bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 723bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// isBitcodeFileForTarget - Returns 'true' if the file or memory contents 733bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// is LLVM bitcode for the specified triple. 743c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling static bool isBitcodeFileForTarget(const void *mem, 753bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling size_t length, 763bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling const char *triplePrefix); 773c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling static bool isBitcodeFileForTarget(const char *path, 783bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling const char *triplePrefix); 793bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 803bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// makeLTOModule - Create an LTOModule. N.B. These methods take ownership 813bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// of the buffer. 823bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling static LTOModule *makeLTOModule(const char* path, 833bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling std::string &errMsg); 843bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling static LTOModule *makeLTOModule(int fd, const char *path, 853bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling size_t size, std::string &errMsg); 863bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling static LTOModule *makeLTOModule(int fd, const char *path, 873bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling size_t file_size, 883bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling size_t map_size, 893bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling off_t offset, 903bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling std::string& errMsg); 913bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling static LTOModule *makeLTOModule(const void *mem, size_t length, 923bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling std::string &errMsg); 933bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 943bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// getTargetTriple - Return the Module's target triple. 953bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling const char *getTargetTriple() { 963bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling return _module->getTargetTriple().c_str(); 973bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling } 983bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 993bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// setTargetTriple - Set the Module's target triple. 1003bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling void setTargetTriple(const char *triple) { 1013bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling _module->setTargetTriple(triple); 1023bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling } 1033bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 1043bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// getSymbolCount - Get the number of symbols 1053bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling uint32_t getSymbolCount() { 1063bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling return _symbols.size(); 1073bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling } 1083bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 1093bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// getSymbolAttributes - Get the attributes for a symbol at the specified 1103bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// index. 1113bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling lto_symbol_attributes getSymbolAttributes(uint32_t index) { 1123bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling if (index < _symbols.size()) 1133c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling return lto_symbol_attributes(_symbols[index].attributes); 1143c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling return lto_symbol_attributes(0); 1153bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling } 1163bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 1173bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// getSymbolName - Get the name of the symbol at the specified index. 1183bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling const char *getSymbolName(uint32_t index) { 1193bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling if (index < _symbols.size()) 1203bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling return _symbols[index].name; 1213c6b29b7e96f4fd0c9f5aae521d52cbf2b4493c2Bill Wendling return NULL; 1223bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling } 1233bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 1243bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// getLLVVMModule - Return the Module. 1253bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling llvm::Module *getLLVVMModule() { return _module.get(); } 1263bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling 1273bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// getAsmUndefinedRefs - 1283bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling const std::vector<const char*> &getAsmUndefinedRefs() { 1293bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling return _asm_undefines; 1303bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling } 13177595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik 13277595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzikprivate: 1333bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// parseSymbols - Parse the symbols from the module and model-level ASM and 1343bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// add them to either the defined or undefined lists. 1353bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling bool parseSymbols(std::string &errMsg); 13662cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1373bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addPotentialUndefinedSymbol - Add a symbol which isn't defined just yet 1383bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// to a list to be resolved later. 13924b878031d4f62baf0e9a0573aeebc9dfd54b546Bill Wendling void addPotentialUndefinedSymbol(llvm::GlobalValue *dcl, bool isFunc); 14062cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1413bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addDefinedSymbol - Add a defined symbol to the list. 1423bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling void addDefinedSymbol(llvm::GlobalValue *def, bool isFunction); 14362cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1443bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addDefinedFunctionSymbol - Add a function symbol as defined to the list. 1453bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling void addDefinedFunctionSymbol(llvm::Function *f); 14662cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1473bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addDefinedDataSymbol - Add a data symbol as defined to the list. 1483bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling void addDefinedDataSymbol(llvm::GlobalValue *v); 14962cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1503bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addAsmGlobalSymbols - Add global symbols from module-level ASM to the 1513bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// defined or undefined lists. 1523bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling bool addAsmGlobalSymbols(std::string &errMsg); 15362cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1543bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addAsmGlobalSymbol - Add a global symbol from module-level ASM to the 1553bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// defined list. 1563bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling void addAsmGlobalSymbol(const char *, lto_symbol_attributes scope); 15762cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1583bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addAsmGlobalSymbolUndef - Add a global symbol from module-level ASM to 1593bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// the undefined list. 1603bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling void addAsmGlobalSymbolUndef(const char *); 1613eb445feb22647e867a339f4c59b0a716b03a21aNick Kledzik 1623bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addObjCClass - Parse i386/ppc ObjC class data structure. 1633bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling void addObjCClass(llvm::GlobalVariable *clgv); 16477595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik 1653bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addObjCCategory - Parse i386/ppc ObjC category data structure. 1663bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling void addObjCCategory(llvm::GlobalVariable *clgv); 16730fe94ea43bd122fb4fd26b84bcf62f8096d4293Bill Wendling 1683bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// addObjCClassRef - Parse i386/ppc ObjC class list data structure. 1693bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling void addObjCClassRef(llvm::GlobalVariable *clgv); 17030fe94ea43bd122fb4fd26b84bcf62f8096d4293Bill Wendling 1713bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// objcClassNameFromExpression - Get string that the data pointer points 1723bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// to. 1733bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling bool objcClassNameFromExpression(llvm::Constant* c, std::string &name); 17462cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1753bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// isTargetMatch - Returns 'true' if the memory buffer is for the specified 1763bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// target triple. 1773bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling static bool isTargetMatch(llvm::MemoryBuffer *memBuffer, 1783bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling const char *triplePrefix); 17962cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1803bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// makeLTOModule - Create an LTOModule (private version). N.B. This 1813bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// method takes ownership of the buffer. 1823bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling static LTOModule *makeLTOModule(llvm::MemoryBuffer *buffer, 1833bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling std::string &errMsg); 18462cf01e4c5de703e7712c72d12f577153b373cbaBill Wendling 1853bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling /// makeBuffer - Create a MemoryBuffer from a memory range. 1863bb17380b1c87fa23ef9fe208ce6f56d352df611Bill Wendling static llvm::MemoryBuffer *makeBuffer(const void *mem, size_t length); 18777595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik}; 18877595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik 18977595fc35642f990bfc5ad05b8e68d4056695ecaNick Kledzik#endif // LTO_MODULE_H 190