lib/Archive/Archive.cpp

   1 //===-- Archive.cpp - Generic LLVM archive functions ------------*- C++ -*-===//
   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 contains the implementation of the Archive and ArchiveMember
  11 // classes that is common to both reading and writing archives..
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "ArchiveInternals.h"
  16 #include "llvm/Bitcode/ReaderWriter.h"
  17 #include "llvm/ModuleProvider.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/Support/MemoryBuffer.h"
  20 #include "llvm/System/Process.h"
  21 #include <memory>
  22 #include <cstring>
  23 using namespace llvm;
  24
  25 // getMemberSize - compute the actual physical size of the file member as seen
  26 // on disk. This isn't the size of member's payload. Use getSize() for that.
  27 unsigned
  28 ArchiveMember::getMemberSize() const {
  29   // Basically its the file size plus the header size
  30   unsigned result =  info.fileSize + sizeof(ArchiveMemberHeader);
  31
  32   // If it has a long filename, include the name length
  33   if (hasLongFilename())
  34     result += path.toString().length() + 1;
  35
  36   // If its now odd lengthed, include the padding byte
  37   if (result % 2 != 0 )
  38     result++;
  39
  40   return result;
  41 }
  42
  43 // This default constructor is only use by the ilist when it creates its
  44 // sentry node. We give it specific static values to make it stand out a bit.
  45 ArchiveMember::ArchiveMember()
  46   : next(0), prev(0), parent(0), path("--invalid--"), flags(0), data(0)
  47 {
  48   info.user = sys::Process::GetCurrentUserId();
  49   info.group = sys::Process::GetCurrentGroupId();
  50   info.mode = 0777;
  51   info.fileSize = 0;
  52   info.modTime = sys::TimeValue::now();
  53 }
  54
  55 // This is the constructor that the Archive class uses when it is building or
  56 // reading an archive. It just defaults a few things and ensures the parent is
  57 // set for the iplist. The Archive class fills in the ArchiveMember's data.
  58 // This is required because correctly setting the data may depend on other
  59 // things in the Archive.
  60 ArchiveMember::ArchiveMember(Archive* PAR)
  61   : next(0), prev(0), parent(PAR), path(), flags(0), data(0)
  62 {
  63 }
  64
  65 // This method allows an ArchiveMember to be replaced with the data for a
  66 // different file, presumably as an update to the member. It also makes sure
  67 // the flags are reset correctly.
  68 bool ArchiveMember::replaceWith(const sys::Path& newFile, std::string* ErrMsg) {
  69   if (!newFile.exists()) {
  70     if (ErrMsg)
  71       *ErrMsg = "Can not replace an archive member with a non-existent file";
  72     return true;
  73   }
  74
  75   data = 0;
  76   path = newFile;
  77
  78   // SVR4 symbol tables have an empty name
  79   if (path.toString() == ARFILE_SVR4_SYMTAB_NAME)
  80     flags |= SVR4SymbolTableFlag;
  81   else
  82     flags &= ~SVR4SymbolTableFlag;
  83
  84   // BSD4.4 symbol tables have a special name
  85   if (path.toString() == ARFILE_BSD4_SYMTAB_NAME)
  86     flags |= BSD4SymbolTableFlag;
  87   else
  88     flags &= ~BSD4SymbolTableFlag;
  89
  90   // LLVM symbol tables have a very specific name
  91   if (path.toString() == ARFILE_LLVM_SYMTAB_NAME)
  92     flags |= LLVMSymbolTableFlag;
  93   else
  94     flags &= ~LLVMSymbolTableFlag;
  95
  96   // String table name
  97   if (path.toString() == ARFILE_STRTAB_NAME)
  98     flags |= StringTableFlag;
  99   else
 100     flags &= ~StringTableFlag;
 101
 102   // If it has a slash then it has a path
 103   bool hasSlash = path.toString().find('/') != std::string::npos;
 104   if (hasSlash)
 105     flags |= HasPathFlag;
 106   else
 107     flags &= ~HasPathFlag;
 108
 109   // If it has a slash or its over 15 chars then its a long filename format
 110   if (hasSlash || path.toString().length() > 15)
 111     flags |= HasLongFilenameFlag;
 112   else
 113     flags &= ~HasLongFilenameFlag;
 114
 115   // Get the signature and status info
 116   const char* signature = (const char*) data;
 117   std::string magic;
 118   if (!signature) {
 119     path.getMagicNumber(magic,4);
 120     signature = magic.c_str();
 121     std::string err;
 122     const sys::FileStatus *FSinfo = path.getFileStatus(false, ErrMsg);
 123     if (FSinfo)
 124       info = *FSinfo;
 125     else
 126       return true;
 127   }
 128
 129   // Determine what kind of file it is
 130   switch (sys::IdentifyFileType(signature,4)) {
 131     default:
 132       flags &= ~BitcodeFlag;
 133       break;
 134   }
 135   return false;
 136 }
 137
 138 // Archive constructor - this is the only constructor that gets used for the
 139 // Archive class. Everything else (default,copy) is deprecated. This just
 140 // initializes and maps the file into memory, if requested.
 141 Archive::Archive(const sys::Path& filename)
 142   : archPath(filename), members(), mapfile(0), base(0), symTab(), strtab(),
 143     symTabSize(0), firstFileOffset(0), modules(), foreignST(0) {
 144 }
 145
 146 bool
 147 Archive::mapToMemory(std::string* ErrMsg)
 148 {
 149   mapfile = new sys::MappedFile();
 150   if (mapfile->open(archPath, sys::MappedFile::READ_ACCESS, ErrMsg))
 151     return true;
 152   if (!(base = (char*) mapfile->map(ErrMsg)))
 153     return true;
 154   return false;
 155 }
 156
 157 void Archive::cleanUpMemory() {
 158   // Shutdown the file mapping
 159   if (mapfile) {
 160     mapfile->close();
 161     delete mapfile;
 162
 163     mapfile = 0;
 164     base = 0;
 165   }
 166
 167   // Forget the entire symbol table
 168   symTab.clear();
 169   symTabSize = 0;
 170
 171   firstFileOffset = 0;
 172
 173   // Free the foreign symbol table member
 174   if (foreignST) {
 175     delete foreignST;
 176     foreignST = 0;
 177   }
 178
 179   // Delete any ModuleProviders and ArchiveMember's we've allocated as a result
 180   // of symbol table searches.
 181   for (ModuleMap::iterator I=modules.begin(), E=modules.end(); I != E; ++I ) {
 182     delete I->second.first;
 183     delete I->second.second;
 184   }
 185 }
 186
 187 // Archive destructor - just clean up memory
 188 Archive::~Archive() {
 189   cleanUpMemory();
 190 }
 191
 192
 193
 194 static void getSymbols(Module*M, std::vector<std::string>& symbols) {
 195   // Loop over global variables
 196   for (Module::global_iterator GI = M->global_begin(), GE=M->global_end(); GI != GE; ++GI)
 197     if (!GI->isDeclaration() && !GI->hasInternalLinkage())
 198       if (!GI->getName().empty())
 199         symbols.push_back(GI->getName());
 200
 201   // Loop over functions
 202   for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI)
 203     if (!FI->isDeclaration() && !FI->hasInternalLinkage())
 204       if (!FI->getName().empty())
 205         symbols.push_back(FI->getName());
 206
 207   // Loop over aliases
 208   for (Module::alias_iterator AI = M->alias_begin(), AE = M->alias_end();
 209        AI != AE; ++AI) {
 210     const GlobalValue *Aliased = AI->getAliasedGlobal();
 211     if (!Aliased->isDeclaration())
 212       if (AI->hasName())
 213         symbols.push_back(AI->getName());
 214   }
 215 }
 216
 217 // Get just the externally visible defined symbols from the bitcode
 218 bool llvm::GetBitcodeSymbols(const sys::Path& fName,
 219                              std::vector<std::string>& symbols,
 220                              std::string* ErrMsg) {
 221   std::auto_ptr<MemoryBuffer> Buffer(
 222                        MemoryBuffer::getFileOrSTDIN(&fName.toString()[0],
 223                                                     fName.toString().size()));
 224   if (!Buffer.get()) {
 225     if (ErrMsg) *ErrMsg = "Could not open file '" + fName.toString() + "'";
 226     return true;
 227   }
 228
 229   ModuleProvider *MP = getBitcodeModuleProvider(Buffer.get(), ErrMsg);
 230   if (!MP)
 231     return true;
 232
 233   // Get the module from the provider
 234   Module* M = MP->materializeModule();
 235   if (M == 0) {
 236     delete MP;
 237     return true;
 238   }
 239
 240   // Get the symbols
 241   getSymbols(M, symbols);
 242
 243   // Done with the module.
 244   delete MP;
 245   return true;
 246 }
 247
 248 ModuleProvider*
 249 llvm::GetBitcodeSymbols(const unsigned char *BufPtr, unsigned Length,
 250                         const std::string& ModuleID,
 251                         std::vector<std::string>& symbols,
 252                         std::string* ErrMsg) {
 253   // Get the module provider
 254   MemoryBuffer *Buffer =MemoryBuffer::getNewMemBuffer(Length, ModuleID.c_str());
 255   memcpy((char*)Buffer->getBufferStart(), BufPtr, Length);
 256
 257   ModuleProvider *MP = getBitcodeModuleProvider(Buffer, ErrMsg);
 258   if (!MP)
 259     return 0;
 260
 261   // Get the module from the provider
 262   Module* M = MP->materializeModule();
 263   if (M == 0) {
 264     delete MP;
 265     return 0;
 266   }
 267
 268   // Get the symbols
 269   getSymbols(M, symbols);
 270
 271   // Done with the module. Note that ModuleProvider will delete the
 272   // Module when it is deleted. Also note that its the caller's responsibility
 273   // to delete the ModuleProvider.
 274   return MP;
 275 }