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