For PR797:
[oota-llvm.git] / lib / Archive / ArchiveWriter.cpp
index bd9851eb5989151833e113072013a647ddcd6944..3746dbff8a12b49b623c4a230212f8c75a92fbc3 100644 (file)
@@ -1,10 +1,10 @@
 //===-- ArchiveWriter.cpp - Write LLVM archive files ----------------------===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Reid Spencer and is distributed under the 
+// This file was developed by Reid Spencer and is distributed under the
 // University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+//
 //===----------------------------------------------------------------------===//
 //
 // Builds up an LLVM archive file (.a) containing LLVM bytecode.
@@ -13,9 +13,9 @@
 
 #include "ArchiveInternals.h"
 #include "llvm/Bytecode/Reader.h"
-#include "llvm/Support/FileUtilities.h"
 #include "llvm/Support/Compressor.h"
 #include "llvm/System/Signals.h"
+#include "llvm/System/Process.h"
 #include <fstream>
 #include <iostream>
 #include <iomanip>
@@ -30,7 +30,7 @@ inline void writeInteger(unsigned num, std::ofstream& ARFile) {
       ARFile << (unsigned char)num;
       return;
     }
-    
+
     // Nope, we are bigger than a character, output the next 7 bits and set the
     // high bit to say that there is more coming...
     ARFile << (unsigned char)(0x80 | ((unsigned char)num & 0x7F));
@@ -44,9 +44,9 @@ inline unsigned numVbrBytes(unsigned num) {
 
   // Note that the following nested ifs are somewhat equivalent to a binary
   // search. We split it in half by comparing against 2^14 first. This allows
-  // most reasonable values to be done in 2 comparisons instead of 1 for 
+  // most reasonable values to be done in 2 comparisons instead of 1 for
   // small ones and four for large ones. We expect this to access file offsets
-  // in the 2^10 to 2^24 range and symbol lengths in the 2^0 to 2^8 range, 
+  // in the 2^10 to 2^24 range and symbol lengths in the 2^0 to 2^8 range,
   // so this approach is reasonable.
   if (num < 1<<14)
     if (num < 1<<7)
@@ -62,17 +62,17 @@ inline unsigned numVbrBytes(unsigned num) {
 }
 
 // Create an empty archive.
-Archive* 
+Archive*
 Archive::CreateEmpty(const sys::Path& FilePath ) {
-  Archive* result = new Archive(FilePath,false);
+  Archive* result = new Archive(FilePath);
   return result;
 }
 
-// Fill the ArchiveMemberHeader with the information from a member. If 
+// Fill the ArchiveMemberHeader with the information from a member. If
 // TruncateNames is true, names are flattened to 15 chars or less. The sz field
-// is provided here instead of coming from the mbr because the member might be 
-// stored compressed and the compressed size is not the ArchiveMember's size. 
-// Furthermore compressed files have negative size fields to identify them as 
+// is provided here instead of coming from the mbr because the member might be
+// stored compressed and the compressed size is not the ArchiveMember's size.
+// Furthermore compressed files have negative size fields to identify them as
 // compressed.
 bool
 Archive::fillHeader(const ArchiveMember &mbr, ArchiveMemberHeader& hdr,
@@ -94,7 +94,7 @@ Archive::fillHeader(const ArchiveMember &mbr, ArchiveMemberHeader& hdr,
   memcpy(hdr.date,buffer,12);
 
   // Get rid of trailing blanks in the name
-  std::string mbrPath = mbr.getPath().get();
+  std::string mbrPath = mbr.getPath().toString();
   size_t mbrLen = mbrPath.length();
   while (mbrLen > 0 && mbrPath[mbrLen-1] == ' ') {
     mbrPath.erase(mbrLen-1,1);
@@ -105,8 +105,10 @@ Archive::fillHeader(const ArchiveMember &mbr, ArchiveMemberHeader& hdr,
   bool writeLongName = false;
   if (mbr.isStringTable()) {
     memcpy(hdr.name,ARFILE_STRTAB_NAME,16);
-  } else if (mbr.isForeignSymbolTable()) {
-    memcpy(hdr.name,ARFILE_SYMTAB_NAME,16);
+  } else if (mbr.isSVR4SymbolTable()) {
+    memcpy(hdr.name,ARFILE_SVR4_SYMTAB_NAME,16);
+  } else if (mbr.isBSD4SymbolTable()) {
+    memcpy(hdr.name,ARFILE_BSD4_SYMTAB_NAME,16);
   } else if (mbr.isLLVMSymbolTable()) {
     memcpy(hdr.name,ARFILE_LLVM_SYMTAB_NAME,16);
   } else if (TruncateNames) {
@@ -117,7 +119,7 @@ Archive::fillHeader(const ArchiveMember &mbr, ArchiveMemberHeader& hdr,
       nm += slashpos + 1;
       len -= slashpos +1;
     }
-    if (len > 15) 
+    if (len > 15)
       len = 15;
     memcpy(hdr.name,nm,len);
     hdr.name[len] = '/';
@@ -149,21 +151,23 @@ Archive::fillHeader(const ArchiveMember &mbr, ArchiveMemberHeader& hdr,
 
 // Insert a file into the archive before some other member. This also takes care
 // of extracting the necessary flags and information from the file.
-void
-Archive::addFileBefore(const sys::Path& filePath, iterator where) {
+bool
+Archive::addFileBefore(const sys::Path& filePath, iterator where, 
+                        std::string* ErrMsg) {
   assert(filePath.exists() && "Can't add a non-existent file");
 
   ArchiveMember* mbr = new ArchiveMember(this);
 
   mbr->data = 0;
   mbr->path = filePath;
-  mbr->path.getStatusInfo(mbr->info);
+  if (mbr->path.getFileStatus(mbr->info, ErrMsg))
+    return true;
 
   unsigned flags = 0;
-  bool hasSlash = filePath.get().find('/') != std::string::npos;
+  bool hasSlash = filePath.toString().find('/') != std::string::npos;
   if (hasSlash)
     flags |= ArchiveMember::HasPathFlag;
-  if (hasSlash || filePath.get().length() > 15)
+  if (hasSlash || filePath.toString().length() > 15)
     flags |= ArchiveMember::HasLongFilenameFlag;
   std::string magic;
   mbr->path.getMagicNumber(magic,4);
@@ -179,16 +183,18 @@ Archive::addFileBefore(const sys::Path& filePath, iterator where) {
   }
   mbr->flags = flags;
   members.insert(where,mbr);
+  return false;
 }
 
 // Write one member out to the file.
-void
+bool
 Archive::writeMember(
   const ArchiveMember& member,
   std::ofstream& ARFile,
   bool CreateSymbolTable,
   bool TruncateNames,
-  bool ShouldCompress 
+  bool ShouldCompress,
+  std::string* ErrMsg
 ) {
 
   unsigned filepos = ARFile.tellp();
@@ -200,50 +206,60 @@ Archive::writeMember(
   const char* data = (const char*)member.getData();
   sys::MappedFile* mFile = 0;
   if (!data) {
-    mFile = new sys::MappedFile(member.getPath());
-    data = (const char*) mFile->map();
+    mFile = new sys::MappedFile();
+    if (mFile->open(member.getPath(), sys::MappedFile::READ_ACCESS, ErrMsg))
+      return true;
+    if (!(data = (const char*) mFile->map(ErrMsg)))
+      return true;
     fSize = mFile->size();
-  } 
+  }
 
-  // Now that we have the data in memory, update the 
+  // Now that we have the data in memory, update the
   // symbol table if its a bytecode file.
-  if (CreateSymbolTable && 
+  if (CreateSymbolTable &&
       (member.isBytecode() || member.isCompressedBytecode())) {
     std::vector<std::string> symbols;
-    std::string FullMemberName = archPath.get() + "(" + member.getPath().get() 
+    std::string FullMemberName = archPath.toString() + "(" +
+      member.getPath().toString()
       + ")";
     ModuleProvider* MP = GetBytecodeSymbols(
       (const unsigned char*)data,fSize,FullMemberName, symbols);
 
     // If the bytecode parsed successfully
     if ( MP ) {
-      for (std::vector<std::string>::iterator SI = symbols.begin(), 
+      for (std::vector<std::string>::iterator SI = symbols.begin(),
            SE = symbols.end(); SI != SE; ++SI) {
 
-        std::pair<SymTabType::iterator,bool> Res = 
+        std::pair<SymTabType::iterator,bool> Res =
           symTab.insert(std::make_pair(*SI,filepos));
 
         if (Res.second) {
-          symTabSize += SI->length() + 
-                        numVbrBytes(SI->length()) + 
+          symTabSize += SI->length() +
+                        numVbrBytes(SI->length()) +
                         numVbrBytes(filepos);
         }
       }
       // We don't need this module any more.
       delete MP;
     } else {
-      throw std::string("Can't parse bytecode member: ") + 
-             member.getPath().get();
+      if (mFile != 0) {
+        mFile->close();
+        delete mFile;
+      }
+      if (ErrMsg)
+        *ErrMsg = "Can't parse bytecode member: " + member.getPath().toString();
+      return true;
     }
   }
 
   // Determine if we actually should compress this member
-  bool willCompress = 
-      (ShouldCompress && 
-      !member.isForeignSymbolTable() &&
+  bool willCompress =
+      (ShouldCompress &&
+      !member.isCompressed() &&
+      !member.isCompressedBytecode() &&
       !member.isLLVMSymbolTable() &&
-      !member.isCompressed() && 
-      !member.isCompressedBytecode());
+      !member.isSVR4SymbolTable() &&
+      !member.isBSD4SymbolTable());
 
   // Perform the compression. Note that if the file is uncompressed bytecode
   // then we turn the file into compressed bytecode rather than treating it as
@@ -259,11 +275,12 @@ Archive::writeMember(
       data +=4;
       fSize -= 4;
     }
-    fSize = Compressor::compressToNewBuffer(
-              data,fSize,output,Compressor::COMP_TYPE_ZLIB);
+    fSize = Compressor::compressToNewBuffer(data,fSize,output,ErrMsg);
+    if (fSize == 0)
+      return true;
     data = output;
     if (member.isBytecode())
-      hdrSize = -fSize-4; 
+      hdrSize = -fSize-4;
     else
       hdrSize = -fSize;
   } else {
@@ -279,7 +296,8 @@ Archive::writeMember(
 
   // Write the long filename if its long
   if (writeLongName) {
-    ARFile.write(member.getPath().get().data(),member.getPath().get().length());
+    ARFile.write(member.getPath().toString().data(),
+                 member.getPath().toString().length());
   }
 
   // Make sure we write the compressed bytecode magic number if we should.
@@ -290,7 +308,7 @@ Archive::writeMember(
   ARFile.write(data,fSize);
 
   // Make sure the member is an even length
-  if (ARFile.tellp() % 2 != 0)
+  if ((ARFile.tellp() & 1) == 1)
     ARFile << ARFILE_PAD;
 
   // Free the compressed data, if necessary
@@ -300,9 +318,10 @@ Archive::writeMember(
 
   // Close the mapped file if it was opened
   if (mFile != 0) {
-    mFile->unmap();
+    mFile->close();
     delete mFile;
   }
+  return false;
 }
 
 // Write out the LLVM symbol table as an archive member to the file.
@@ -315,6 +334,12 @@ Archive::writeSymbolTable(std::ofstream& ARFile) {
   memcpy(Hdr.name,ARFILE_LLVM_SYMTAB_NAME,16);
   uint64_t secondsSinceEpoch = sys::TimeValue::now().toEpochTime();
   char buffer[32];
+  sprintf(buffer, "%-8o", 0644);
+  memcpy(Hdr.mode,buffer,8);
+  sprintf(buffer, "%-6u", sys::Process::GetCurrentUserId());
+  memcpy(Hdr.uid,buffer,6);
+  sprintf(buffer, "%-6u", sys::Process::GetCurrentGroupId());
+  memcpy(Hdr.gid,buffer,6);
   sprintf(buffer,"%-12u", unsigned(secondsSinceEpoch));
   memcpy(Hdr.date,buffer,12);
   sprintf(buffer,"%-10u",symTabSize);
@@ -351,100 +376,137 @@ Archive::writeSymbolTable(std::ofstream& ARFile) {
 }
 
 // Write the entire archive to the file specified when the archive was created.
-// This writes to a temporary file first. Options are for creating a symbol 
-// table, flattening the file names (no directories, 15 chars max) and 
+// This writes to a temporary file first. Options are for creating a symbol
+// table, flattening the file names (no directories, 15 chars max) and
 // compressing each archive member.
-void
-Archive::writeToDisk(bool CreateSymbolTable, bool TruncateNames, bool Compress){
-  
+bool
+Archive::writeToDisk(bool CreateSymbolTable, bool TruncateNames, bool Compress,
+                     std::string* ErrMsg)
+{
   // Make sure they haven't opened up the file, not loaded it,
   // but are now trying to write it which would wipe out the file.
-  assert(!(members.empty() && mapfile->size() > 8) && 
+  assert(!(members.empty() && mapfile->size() > 8) &&
          "Can't write an archive not opened for writing");
 
   // Create a temporary file to store the archive in
   sys::Path TmpArchive = archPath;
-  TmpArchive.createTemporaryFile();
+  if (TmpArchive.createTemporaryFileOnDisk(ErrMsg))
+    return true;
 
   // Make sure the temporary gets removed if we crash
   sys::RemoveFileOnSignal(TmpArchive);
 
-  // Ensure we can remove the temporary even in the face of an exception
-  try {
-    // Create archive file for output.
-    std::ofstream ArchiveFile(TmpArchive.c_str());
-  
-    // Check for errors opening or creating archive file.
-    if ( !ArchiveFile.is_open() || ArchiveFile.bad() ) {
-      throw std::string("Error opening archive file: ") + archPath.get();
-    }
+  // Create archive file for output.
+  std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
+                               std::ios::binary;
+  std::ofstream ArchiveFile(TmpArchive.c_str(), io_mode);
 
-    // If we're creating a symbol table, reset it now
-    if (CreateSymbolTable) {
-      symTabSize = 0;
-      symTab.clear();
-    }
+  // Check for errors opening or creating archive file.
+  if (!ArchiveFile.is_open() || ArchiveFile.bad()) {
+    if (TmpArchive.exists())
+      TmpArchive.eraseFromDisk();
+    if (ErrMsg)
+      *ErrMsg = "Error opening archive file: " + archPath.toString();
+    return true;
+  }
 
-    // Write magic string to archive.
-    ArchiveFile << ARFILE_MAGIC;
+  // If we're creating a symbol table, reset it now
+  if (CreateSymbolTable) {
+    symTabSize = 0;
+    symTab.clear();
+  }
 
-    // Loop over all member files, and write them out. Note that this also
-    // builds the symbol table, symTab.
-    for ( MembersList::iterator I = begin(), E = end(); I != E; ++I) {
-      writeMember(*I,ArchiveFile,CreateSymbolTable,TruncateNames,Compress);
+  // Write magic string to archive.
+  ArchiveFile << ARFILE_MAGIC;
+
+  // Loop over all member files, and write them out. Note that this also
+  // builds the symbol table, symTab.
+  for (MembersList::iterator I = begin(), E = end(); I != E; ++I) {
+    if (writeMember(*I, ArchiveFile, CreateSymbolTable,
+                     TruncateNames, Compress, ErrMsg)) {
+      if (TmpArchive.exists())
+        TmpArchive.eraseFromDisk();
+      ArchiveFile.close();
+      return true;
     }
+  }
 
-    // Close archive file.
-    ArchiveFile.close();
-
-    // Write the symbol table
-    if (CreateSymbolTable) {
-      // At this point we have written a file that is a legal archive but it
-      // doesn't have a symbol table in it. To aid in faster reading and to
-      // ensure compatibility with other archivers we need to put the symbol
-      // table first in the file. Unfortunately, this means mapping the file
-      // we just wrote back in and copying it to the destination file.
-
-      // Map in the archive we just wrote.
-      sys::MappedFile arch(TmpArchive);
-      const char* base = (const char*) arch.map();
-
-      // Open the final file to write and check it.
-      std::ofstream FinalFile(archPath.c_str());
-      if ( !FinalFile.is_open() || FinalFile.bad() ) {
-        throw std::string("Error opening archive file: ") + archPath.get();
-      }
-
-      // Write the file magic number
-      FinalFile << ARFILE_MAGIC;
+  // Close archive file.
+  ArchiveFile.close();
+
+  // Write the symbol table
+  if (CreateSymbolTable) {
+    // At this point we have written a file that is a legal archive but it
+    // doesn't have a symbol table in it. To aid in faster reading and to
+    // ensure compatibility with other archivers we need to put the symbol
+    // table first in the file. Unfortunately, this means mapping the file
+    // we just wrote back in and copying it to the destination file.
+
+    // Map in the archive we just wrote.
+    sys::MappedFile arch;
+    if (arch.open(TmpArchive, sys::MappedFile::READ_ACCESS, ErrMsg))
+      return true;
+    const char* base;
+    if (!(base = (const char*) arch.map(ErrMsg)))
+      return true;
+
+    // Open another temporary file in order to avoid invalidating the 
+    // mmapped data
+    sys::Path FinalFilePath = archPath;
+    if (FinalFilePath.createTemporaryFileOnDisk(ErrMsg))
+      return true;
+    sys::RemoveFileOnSignal(FinalFilePath);
+
+    std::ofstream FinalFile(FinalFilePath.c_str(), io_mode);
+    if (!FinalFile.is_open() || FinalFile.bad()) {
+      if (TmpArchive.exists())
+        TmpArchive.eraseFromDisk();
+      if (ErrMsg)
+        *ErrMsg = "Error opening archive file: " + FinalFilePath.toString();
+      return true;
+    }
 
-      // If there is a foreign symbol table, put it into the file now.
-      if (foreignST) {
-        writeMember(*foreignST, FinalFile, false, false, false);
+    // Write the file magic number
+    FinalFile << ARFILE_MAGIC;
+
+    // If there is a foreign symbol table, put it into the file now. Most
+    // ar(1) implementations require the symbol table to be first but llvm-ar
+    // can deal with it being after a foreign symbol table. This ensures
+    // compatibility with other ar(1) implementations as well as allowing the
+    // archive to store both native .o and LLVM .bc files, both indexed.
+    if (foreignST) {
+      if (writeMember(*foreignST, FinalFile, false, false, false, ErrMsg)) {
+        FinalFile.close();
+        if (TmpArchive.exists())
+          TmpArchive.eraseFromDisk();
+        return true;
       }
+    }
 
-      // Put out the LLVM symbol table now.
-      writeSymbolTable(FinalFile);
-
-      // Copy the temporary file contents being sure to skip the file's magic
-      // number.
-      FinalFile.write(base + sizeof(ARFILE_MAGIC)-1, 
-        arch.size()-sizeof(ARFILE_MAGIC)+1);
+    // Put out the LLVM symbol table now.
+    writeSymbolTable(FinalFile);
 
-      // Close up shop
-      FinalFile.close();
-      arch.unmap();
-      TmpArchive.destroyFile();
+    // Copy the temporary file contents being sure to skip the file's magic
+    // number.
+    FinalFile.write(base + sizeof(ARFILE_MAGIC)-1,
+      arch.size()-sizeof(ARFILE_MAGIC)+1);
 
-    } else {
-      // We don't have to insert the symbol table, so just renaming the temp
-      // file to the correct name will suffice.
-      TmpArchive.renameFile(archPath);
-    }
-  } catch (...) {
-    // Make sure we clean up.
-    if (TmpArchive.exists())
-      TmpArchive.destroyFile();
-    throw;
+    // Close up shop
+    FinalFile.close();
+    arch.close();
+    
+    // Move the final file over top of TmpArchive
+    if (FinalFilePath.renamePathOnDisk(TmpArchive, ErrMsg))
+      return true;
   }
+  
+  // Before we replace the actual archive, we need to forget all the
+  // members, since they point to data in that old archive. We need to do
+  // this because we cannot replace an open file on Windows.
+  cleanUpMemory();
+  
+  if (TmpArchive.renamePathOnDisk(archPath, ErrMsg))
+    return true;
+
+  return false;
 }