tools/lto2/LTOModule.cpp

   1 //===-LTOModule.cpp - 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 implements the Link Time Optimization library. This library is
  11 // intended to be used by linker to optimize code at link time.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "LTOModule.h"
  16
  17 #include "llvm/Module.h"
  18 #include "llvm/ModuleProvider.h"
  19 #include "llvm/ADT/OwningPtr.h"
  20 #include "llvm/Bitcode/ReaderWriter.h"
  21 #include "llvm/Support/SystemUtils.h"
  22 #include "llvm/Support/Mangler.h"
  23 #include "llvm/Support/MemoryBuffer.h"
  24 #include "llvm/Support/MathExtras.h"
  25 #include "llvm/System/Path.h"
  26 #include "llvm/System/Process.h"
  27 #include "llvm/Target/TargetMachine.h"
  28 #include "llvm/Target/TargetMachineRegistry.h"
  29 #include "llvm/Target/TargetAsmInfo.h"
  30
  31
  32 #include <fstream>
  33
  34 using namespace llvm;
  35
  36 bool LTOModule::isBitcodeFile(const void* mem, size_t length)
  37 {
  38     return ( llvm::sys::IdentifyFileType((char*)mem, length)
  39                                             == llvm::sys::Bitcode_FileType );
  40 }
  41
  42 bool LTOModule::isBitcodeFile(const char* path)
  43 {
  44     return llvm::sys::Path(path).isBitcodeFile();
  45 }
  46
  47 bool LTOModule::isBitcodeFileForTarget(const void* mem, size_t length,
  48                                        const char* triplePrefix)
  49 {
  50     MemoryBuffer* buffer = makeBuffer(mem, length);
  51     if ( buffer == NULL )
  52         return false;
  53     return isTargetMatch(buffer, triplePrefix);
  54 }
  55
  56
  57 bool LTOModule::isBitcodeFileForTarget(const char* path,
  58                                        const char* triplePrefix)
  59 {
  60     MemoryBuffer *buffer = MemoryBuffer::getFile(path);
  61     if (buffer == NULL)
  62         return false;
  63     return isTargetMatch(buffer, triplePrefix);
  64 }
  65
  66 // takes ownership of buffer
  67 bool LTOModule::isTargetMatch(MemoryBuffer* buffer, const char* triplePrefix)
  68 {
  69     OwningPtr<ModuleProvider> mp(getBitcodeModuleProvider(buffer));
  70     // on success, mp owns buffer and both are deleted at end of this method
  71     if ( !mp ) {
  72         delete buffer;
  73         return false;
  74     }
  75     std::string actualTarget = mp->getModule()->getTargetTriple();
  76     return ( strncmp(actualTarget.c_str(), triplePrefix,
  77                     strlen(triplePrefix)) == 0);
  78 }
  79
  80
  81 LTOModule::LTOModule(Module* m, TargetMachine* t)
  82  : _module(m), _target(t), _symbolsParsed(false)
  83 {
  84 }
  85
  86 LTOModule* LTOModule::makeLTOModule(const char* path, std::string& errMsg)
  87 {
  88     OwningPtr<MemoryBuffer> buffer(MemoryBuffer::getFile(path, &errMsg));
  89     if ( !buffer )
  90         return NULL;
  91     return makeLTOModule(buffer.get(), errMsg);
  92 }
  93
  94 /// makeBuffer - create a MemoryBuffer from a memory range.
  95 /// MemoryBuffer requires the byte past end of the buffer to be a zero.
  96 /// We might get lucky and already be that way, otherwise make a copy.
  97 /// Also if next byte is on a different page, don't assume it is readable.
  98 MemoryBuffer* LTOModule::makeBuffer(const void* mem, size_t length)
  99 {
 100         const char* startPtr = (char*)mem;
 101         const char* endPtr = startPtr+length;
 102         if ( (((uintptr_t)endPtr & (sys::Process::GetPageSize()-1)) == 0)
 103             || (*endPtr != 0) )
 104                 return MemoryBuffer::getMemBufferCopy(startPtr, endPtr);
 105         else
 106                 return MemoryBuffer::getMemBuffer(startPtr, endPtr);
 107 }
 108
 109
 110 LTOModule* LTOModule::makeLTOModule(const void* mem, size_t length,
 111                                                         std::string& errMsg)
 112 {
 113     OwningPtr<MemoryBuffer> buffer(makeBuffer(mem, length));
 114     if ( !buffer )
 115         return NULL;
 116     return makeLTOModule(buffer.get(), errMsg);
 117 }
 118
 119 LTOModule* LTOModule::makeLTOModule(MemoryBuffer* buffer, std::string& errMsg)
 120 {
 121     // parse bitcode buffer
 122     OwningPtr<Module> m(ParseBitcodeFile(buffer, &errMsg));
 123     if ( !m )
 124         return NULL;
 125     // find machine architecture for this module
 126     const TargetMachineRegistry::entry* march =
 127             TargetMachineRegistry::getClosestStaticTargetForModule(*m, errMsg);
 128     if ( march == NULL )
 129         return NULL;
 130     // construct LTModule, hand over ownership of module and target
 131     std::string     features;
 132     TargetMachine*  target = march->CtorFn(*m, features);
 133     return new LTOModule(m.take(), target);
 134 }
 135
 136
 137 const char* LTOModule::getTargetTriple()
 138 {
 139     return _module->getTargetTriple().c_str();
 140 }
 141
 142 void LTOModule::addDefinedFunctionSymbol(Function* f, Mangler &mangler)
 143 {
 144     // add to list of defined symbols
 145     addDefinedSymbol(f, mangler, true);
 146
 147     // add external symbols referenced by this function.
 148     for (Function::iterator b = f->begin(); b != f->end(); ++b) {
 149         for (BasicBlock::iterator i = b->begin(); i != b->end(); ++i) {
 150             for (unsigned count = 0, total = i->getNumOperands();
 151                                         count != total; ++count) {
 152                 findExternalRefs(i->getOperand(count), mangler);
 153             }
 154         }
 155     }
 156 }
 157
 158 void LTOModule::addDefinedDataSymbol(GlobalValue* v, Mangler &mangler)
 159 {
 160     // add to list of defined symbols
 161     addDefinedSymbol(v, mangler, false);
 162
 163     // add external symbols referenced by this data.
 164     for (unsigned count = 0, total = v->getNumOperands();
 165                                                 count != total; ++count) {
 166         findExternalRefs(v->getOperand(count), mangler);
 167     }
 168 }
 169
 170
 171 void LTOModule::addDefinedSymbol(GlobalValue* def, Mangler &mangler,
 172                                 bool isFunction)
 173 {
 174     // string is owned by _defines
 175     const char* symbolName = ::strdup(mangler.getValueName(def).c_str());
 176
 177     // set alignment part log2() can have rounding errors
 178     uint32_t align = def->getAlignment();
 179     uint32_t attr = align ? CountTrailingZeros_32(def->getAlignment()) : 0;
 180
 181     // set permissions part
 182     if ( isFunction )
 183         attr |= LTO_SYMBOL_PERMISSIONS_CODE;
 184     else {
 185         GlobalVariable* gv = dyn_cast<GlobalVariable>(def);
 186         if ( (gv != NULL) && gv->isConstant() )
 187             attr |= LTO_SYMBOL_PERMISSIONS_RODATA;
 188         else
 189             attr |= LTO_SYMBOL_PERMISSIONS_DATA;
 190     }
 191
 192     // set definition part
 193     if ( def->hasWeakLinkage() || def->hasLinkOnceLinkage() ) {
 194         attr |= LTO_SYMBOL_DEFINITION_WEAK;
 195     }
 196     else if ( def->hasCommonLinkage()) {
 197         attr |= LTO_SYMBOL_DEFINITION_TENTATIVE;
 198     }
 199     else {
 200         attr |= LTO_SYMBOL_DEFINITION_REGULAR;
 201     }
 202
 203     // set scope part
 204     if ( def->hasHiddenVisibility() )
 205         attr |= LTO_SYMBOL_SCOPE_HIDDEN;
 206     else if ( def->hasExternalLinkage() || def->hasWeakLinkage() )
 207         attr |= LTO_SYMBOL_SCOPE_DEFAULT;
 208     else
 209         attr |= LTO_SYMBOL_SCOPE_INTERNAL;
 210
 211     // add to table of symbols
 212     NameAndAttributes info;
 213     info.name = symbolName;
 214     info.attributes = (lto_symbol_attributes)attr;
 215     _symbols.push_back(info);
 216     _defines[info.name] = 1;
 217 }
 218
 219
 220 void LTOModule::addPotentialUndefinedSymbol(GlobalValue* decl, Mangler &mangler)
 221 {
 222    const char* name = mangler.getValueName(decl).c_str();
 223     // ignore all llvm.* symbols
 224     if ( strncmp(name, "llvm.", 5) != 0 ) {
 225         _undefines[name] = 1;
 226     }
 227 }
 228
 229
 230
 231 // Find exeternal symbols referenced by VALUE. This is a recursive function.
 232 void LTOModule::findExternalRefs(Value* value, Mangler &mangler) {
 233
 234     if (GlobalValue* gv = dyn_cast<GlobalValue>(value)) {
 235         if ( !gv->hasExternalLinkage() )
 236             addPotentialUndefinedSymbol(gv, mangler);
 237                 // If this is a variable definition, do not recursively process
 238                 // initializer.  It might contain a reference to this variable
 239                 // and cause an infinite loop.  The initializer will be
 240                 // processed in addDefinedDataSymbol().
 241             return;
 242     }
 243
 244     // GlobalValue, even with InternalLinkage type, may have operands with
 245     // ExternalLinkage type. Do not ignore these operands.
 246     if (Constant* c = dyn_cast<Constant>(value)) {
 247         // Handle ConstantExpr, ConstantStruct, ConstantArry etc..
 248         for (unsigned i = 0, e = c->getNumOperands(); i != e; ++i)
 249             findExternalRefs(c->getOperand(i), mangler);
 250     }
 251 }
 252
 253 void LTOModule::lazyParseSymbols()
 254 {
 255     if ( !_symbolsParsed ) {
 256         _symbolsParsed = true;
 257
 258         // Use mangler to add GlobalPrefix to names to match linker names.
 259         Mangler mangler(*_module, _target->getTargetAsmInfo()->getGlobalPrefix());
 260
 261         // add functions
 262         for (Module::iterator f = _module->begin(); f != _module->end(); ++f) {
 263             if ( f->isDeclaration() )
 264                 addPotentialUndefinedSymbol(f, mangler);
 265             else
 266                 addDefinedFunctionSymbol(f, mangler);
 267         }
 268
 269         // add data
 270         for (Module::global_iterator v = _module->global_begin(),
 271                                     e = _module->global_end(); v !=  e; ++v) {
 272             if ( v->isDeclaration() )
 273                 addPotentialUndefinedSymbol(v, mangler);
 274             else
 275                 addDefinedDataSymbol(v, mangler);
 276         }
 277
 278         // make symbols for all undefines
 279         for (StringSet::iterator it=_undefines.begin();
 280                                                 it != _undefines.end(); ++it) {
 281             // if this symbol also has a definition, then don't make an undefine
 282             // because it is a tentative definition
 283             if ( _defines.count(it->getKeyData(), it->getKeyData()+
 284                                                   it->getKeyLength()) == 0 ) {
 285                 NameAndAttributes info;
 286                 info.name = it->getKeyData();
 287                 info.attributes = LTO_SYMBOL_DEFINITION_UNDEFINED;
 288                 _symbols.push_back(info);
 289             }
 290         }
 291     }
 292 }
 293
 294
 295 uint32_t LTOModule::getSymbolCount()
 296 {
 297     lazyParseSymbols();
 298     return _symbols.size();
 299 }
 300
 301
 302 lto_symbol_attributes LTOModule::getSymbolAttributes(uint32_t index)
 303 {
 304     lazyParseSymbols();
 305     if ( index < _symbols.size() )
 306         return _symbols[index].attributes;
 307     else
 308         return lto_symbol_attributes(0);
 309 }
 310
 311 const char* LTOModule::getSymbolName(uint32_t index)
 312 {
 313     lazyParseSymbols();
 314     if ( index < _symbols.size() )
 315         return _symbols[index].name;
 316     else
 317         return NULL;
 318 }
 319