tools/llvm-ar/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 "Archive.h"
  16 #include "ArchiveInternals.h"
  17 #include "llvm/Bitcode/ReaderWriter.h"
  18 #include "llvm/IR/Module.h"
  19 #include "llvm/Support/FileSystem.h"
  20 #include "llvm/Support/MemoryBuffer.h"
  21 #include "llvm/Support/Process.h"
  22 #include "llvm/Support/system_error.h"
  23 #include <cstring>
  24 #include <memory>
  25 using namespace llvm;
  26
  27 // getMemberSize - compute the actual physical size of the file member as seen
  28 // on disk. This isn't the size of member's payload. Use getSize() for that.
  29 unsigned
  30 ArchiveMember::getMemberSize() const {
  31   // Basically its the file size plus the header size
  32   unsigned result = Size + sizeof(ArchiveMemberHeader);
  33
  34   // If it has a long filename, include the name length
  35   if (hasLongFilename())
  36     result += path.length() + 1;
  37
  38   // If its now odd lengthed, include the padding byte
  39   if (result % 2 != 0 )
  40     result++;
  41
  42   return result;
  43 }
  44
  45 // This default constructor is only use by the ilist when it creates its
  46 // sentry node. We give it specific static values to make it stand out a bit.
  47 ArchiveMember::ArchiveMember()
  48   : parent(0), path("--invalid--"), flags(0), data(0)
  49 {
  50   User = sys::Process::GetCurrentUserId();
  51   Group = sys::Process::GetCurrentGroupId();
  52   Mode = 0777;
  53   Size = 0;
  54   ModTime = sys::TimeValue::now();
  55 }
  56
  57 // This is the constructor that the Archive class uses when it is building or
  58 // reading an archive. It just defaults a few things and ensures the parent is
  59 // set for the iplist. The Archive class fills in the ArchiveMember's data.
  60 // This is required because correctly setting the data may depend on other
  61 // things in the Archive.
  62 ArchiveMember::ArchiveMember(Archive* PAR)
  63   : parent(PAR), path(), flags(0), data(0)
  64 {
  65 }
  66
  67 // This method allows an ArchiveMember to be replaced with the data for a
  68 // different file, presumably as an update to the member. It also makes sure
  69 // the flags are reset correctly.
  70 bool ArchiveMember::replaceWith(StringRef newFile, std::string* ErrMsg) {
  71   bool Exists;
  72   if (sys::fs::exists(newFile.str(), Exists) || !Exists) {
  73     if (ErrMsg)
  74       *ErrMsg = "Can not replace an archive member with a non-existent file";
  75     return true;
  76   }
  77
  78   data = 0;
  79   path = newFile.str();
  80
  81   // SVR4 symbol tables have an empty name
  82   if (path == ARFILE_SVR4_SYMTAB_NAME)
  83     flags |= SVR4SymbolTableFlag;
  84   else
  85     flags &= ~SVR4SymbolTableFlag;
  86
  87   // BSD4.4 symbol tables have a special name
  88   if (path == ARFILE_BSD4_SYMTAB_NAME)
  89     flags |= BSD4SymbolTableFlag;
  90   else
  91     flags &= ~BSD4SymbolTableFlag;
  92
  93   // String table name
  94   if (path == ARFILE_STRTAB_NAME)
  95     flags |= StringTableFlag;
  96   else
  97     flags &= ~StringTableFlag;
  98
  99   // If it has a slash or its over 15 chars then its a long filename format
 100   if (path.length() > 15)
 101     flags |= HasLongFilenameFlag;
 102   else
 103     flags &= ~HasLongFilenameFlag;
 104
 105   // Get the signature and status info
 106   const char* signature = (const char*) data;
 107   SmallString<4> magic;
 108   if (!signature) {
 109     sys::fs::get_magic(path, magic.capacity(), magic);
 110     signature = magic.c_str();
 111
 112     sys::fs::file_status Status;
 113     error_code EC = sys::fs::status(path, Status);
 114     if (EC)
 115       return true;
 116
 117     User = Status.getUser();
 118     Group = Status.getGroup();
 119     Mode = Status.permissions();
 120     ModTime = Status.getLastModificationTime();
 121
 122     // FIXME: On posix this is a second stat.
 123     EC = sys::fs::file_size(path, Size);
 124     if (EC)
 125       return true;
 126   }
 127
 128   // Determine what kind of file it is.
 129   if (sys::fs::identify_magic(StringRef(signature, 4)) ==
 130       sys::fs::file_magic::bitcode)
 131     flags |= BitcodeFlag;
 132   else
 133     flags &= ~BitcodeFlag;
 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(StringRef filename, LLVMContext &C)
 142     : archPath(filename), members(), mapfile(0), base(0), strtab(),
 143       firstFileOffset(0), modules(), Context(C) {}
 144
 145 bool
 146 Archive::mapToMemory(std::string* ErrMsg) {
 147   OwningPtr<MemoryBuffer> File;
 148   if (error_code ec = MemoryBuffer::getFile(archPath.c_str(), File)) {
 149     if (ErrMsg)
 150       *ErrMsg = ec.message();
 151     return true;
 152   }
 153   mapfile = File.take();
 154   base = mapfile->getBufferStart();
 155   return false;
 156 }
 157
 158 void Archive::cleanUpMemory() {
 159   // Shutdown the file mapping
 160   delete mapfile;
 161   mapfile = 0;
 162   base = 0;
 163
 164   firstFileOffset = 0;
 165
 166   // Delete any Modules and ArchiveMember's we've allocated as a result of
 167   // symbol table searches.
 168   for (ModuleMap::iterator I=modules.begin(), E=modules.end(); I != E; ++I ) {
 169     delete I->second.first;
 170     delete I->second.second;
 171   }
 172 }
 173
 174 // Archive destructor - just clean up memory
 175 Archive::~Archive() {
 176   cleanUpMemory();
 177 }
 178