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     const sys::FileStatus *FSinfo =
 120       sys::PathWithStatus(path).getFileStatus(false, ErrMsg);
 121     if (FSinfo)
 122       info = *FSinfo;
 123     else
 124       return true;
 125   }
 126
 127   // Determine what kind of file it is
 128   switch (sys::IdentifyFileType(signature,4)) {
 129     case sys::Bytecode_FileType:
 130       flags |= BytecodeFlag;
 131       break;
 132     case sys::CompressedBytecode_FileType:
 133       flags |= CompressedBytecodeFlag;
 134       flags &= ~CompressedFlag;
 135       break;
 136     default:
 137       flags &= ~(BytecodeFlag|CompressedBytecodeFlag);
 138       break;
 139   }
 140   return false;
 141 }
 142
 143 // Archive constructor - this is the only constructor that gets used for the
 144 // Archive class. Everything else (default,copy) is deprecated. This just
 145 // initializes and maps the file into memory, if requested.
 146 Archive::Archive(const sys::Path& filename, BCDecompressor_t *BCDC)
 147   : archPath(filename), members(), mapfile(0), base(0), symTab(), strtab(),
 148     symTabSize(0), firstFileOffset(0), modules(), foreignST(0),
 149     Decompressor(BCDC) {
 150 }
 151
 152 bool
 153 Archive::mapToMemory(std::string* ErrMsg)
 154 {
 155   mapfile = new sys::MappedFile();
 156   if (mapfile->open(archPath, sys::MappedFile::READ_ACCESS, ErrMsg))
 157     return true;
 158   if (!(base = (char*) mapfile->map(ErrMsg)))
 159     return true;
 160   return false;
 161 }
 162
 163 void Archive::cleanUpMemory() {
 164   // Shutdown the file mapping
 165   if (mapfile) {
 166     mapfile->close();
 167     delete mapfile;
 168
 169     mapfile = 0;
 170     base = 0;
 171   }
 172
 173   // Forget the entire symbol table
 174   symTab.clear();
 175   symTabSize = 0;
 176
 177   firstFileOffset = 0;
 178
 179   // Free the foreign symbol table member
 180   if (foreignST) {
 181     delete foreignST;
 182     foreignST = 0;
 183   }
 184
 185   // Delete any ModuleProviders and ArchiveMember's we've allocated as a result
 186   // of symbol table searches.
 187   for (ModuleMap::iterator I=modules.begin(), E=modules.end(); I != E; ++I ) {
 188     delete I->second.first;
 189     delete I->second.second;
 190   }
 191 }
 192
 193 // Archive destructor - just clean up memory
 194 Archive::~Archive() {
 195   cleanUpMemory();
 196 }
 197
 198
 199
 200 static void getSymbols(Module*M, std::vector<std::string>& symbols) {
 201   // Loop over global variables
 202   for (Module::global_iterator GI = M->global_begin(), GE=M->global_end(); GI != GE; ++GI)
 203     if (!GI->isDeclaration() && !GI->hasInternalLinkage())
 204       if (!GI->getName().empty())
 205         symbols.push_back(GI->getName());
 206
 207   // Loop over functions.
 208   for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; ++FI)
 209     if (!FI->isDeclaration() && !FI->hasInternalLinkage())
 210       if (!FI->getName().empty())
 211         symbols.push_back(FI->getName());
 212 }
 213
 214 // Get just the externally visible defined symbols from the bytecode
 215 bool llvm::GetBytecodeSymbols(const sys::Path& fName,
 216                               std::vector<std::string>& symbols,
 217                               BCDecompressor_t *BCDC,
 218                               std::string* ErrMsg) {
 219   ModuleProvider *MP = getBytecodeModuleProvider(fName.toString(), BCDC,ErrMsg);
 220   if (!MP)
 221     return true;
 222
 223   // Get the module from the provider
 224   Module* M = MP->materializeModule();
 225   if (M == 0) {
 226     delete MP;
 227     return true;
 228   }
 229
 230   // Get the symbols
 231   getSymbols(M, symbols);
 232
 233   // Done with the module.
 234   delete MP;
 235   return true;
 236 }
 237
 238 ModuleProvider*
 239 llvm::GetBytecodeSymbols(const unsigned char*Buffer, unsigned Length,
 240                          const std::string& ModuleID,
 241                          std::vector<std::string>& symbols,
 242                          BCDecompressor_t *BCDC,
 243                          std::string* ErrMsg) {
 244   // Get the module provider
 245   ModuleProvider* MP =
 246   getBytecodeBufferModuleProvider(Buffer, Length, ModuleID, BCDC, ErrMsg, 0);
 247   if (!MP)
 248     return 0;
 249
 250   // Get the module from the provider
 251   Module* M = MP->materializeModule();
 252   if (M == 0) {
 253     delete MP;
 254     return 0;
 255   }
 256
 257   // Get the symbols
 258   getSymbols(M, symbols);
 259
 260   // Done with the module. Note that ModuleProvider will delete the
 261   // Module when it is deleted. Also note that its the caller's responsibility
 262   // to delete the ModuleProvider.
 263   return MP;
 264 }