lib/Archive/Archive.cpp

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