tools/llvm-ar/ArchiveWriter.cpp

   1 //===-- ArchiveWriter.cpp - Write LLVM archive files ----------------------===//
   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 // Builds up an LLVM archive file (.a) containing LLVM bitcode.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "Archive.h"
  15 #include "ArchiveInternals.h"
  16 #include "llvm/ADT/OwningPtr.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/Signals.h"
  23 #include "llvm/Support/system_error.h"
  24 #include <fstream>
  25 #include <iomanip>
  26 #include <ostream>
  27 using namespace llvm;
  28
  29 // Write an integer using variable bit rate encoding. This saves a few bytes
  30 // per entry in the symbol table.
  31 static inline void writeInteger(unsigned num, std::ofstream& ARFile) {
  32   while (1) {
  33     if (num < 0x80) { // done?
  34       ARFile << (unsigned char)num;
  35       return;
  36     }
  37
  38     // Nope, we are bigger than a character, output the next 7 bits and set the
  39     // high bit to say that there is more coming...
  40     ARFile << (unsigned char)(0x80 | ((unsigned char)num & 0x7F));
  41     num >>= 7;  // Shift out 7 bits now...
  42   }
  43 }
  44
  45 // Compute how many bytes are taken by a given VBR encoded value. This is needed
  46 // to pre-compute the size of the symbol table.
  47 static inline unsigned numVbrBytes(unsigned num) {
  48
  49   // Note that the following nested ifs are somewhat equivalent to a binary
  50   // search. We split it in half by comparing against 2^14 first. This allows
  51   // most reasonable values to be done in 2 comparisons instead of 1 for
  52   // small ones and four for large ones. We expect this to access file offsets
  53   // in the 2^10 to 2^24 range and symbol lengths in the 2^0 to 2^8 range,
  54   // so this approach is reasonable.
  55   if (num < 1<<14) {
  56     if (num < 1<<7)
  57       return 1;
  58     else
  59       return 2;
  60   }
  61   if (num < 1<<21)
  62     return 3;
  63
  64   if (num < 1<<28)
  65     return 4;
  66   return 5; // anything >= 2^28 takes 5 bytes
  67 }
  68
  69 // Create an empty archive.
  70 Archive* Archive::CreateEmpty(const sys::Path& FilePath, LLVMContext& C) {
  71   Archive* result = new Archive(FilePath, C);
  72   return result;
  73 }
  74
  75 // Fill the ArchiveMemberHeader with the information from a member. If
  76 // TruncateNames is true, names are flattened to 15 chars or less. The sz field
  77 // is provided here instead of coming from the mbr because the member might be
  78 // stored compressed and the compressed size is not the ArchiveMember's size.
  79 // Furthermore compressed files have negative size fields to identify them as
  80 // compressed.
  81 bool
  82 Archive::fillHeader(const ArchiveMember &mbr, ArchiveMemberHeader& hdr,
  83                     int sz, bool TruncateNames) const {
  84
  85   // Set the permissions mode, uid and gid
  86   hdr.init();
  87   char buffer[32];
  88   sprintf(buffer, "%-8o", mbr.getMode());
  89   memcpy(hdr.mode,buffer,8);
  90   sprintf(buffer,  "%-6u", mbr.getUser());
  91   memcpy(hdr.uid,buffer,6);
  92   sprintf(buffer,  "%-6u", mbr.getGroup());
  93   memcpy(hdr.gid,buffer,6);
  94
  95   // Set the last modification date
  96   uint64_t secondsSinceEpoch = mbr.getModTime().toEpochTime();
  97   sprintf(buffer,"%-12u", unsigned(secondsSinceEpoch));
  98   memcpy(hdr.date,buffer,12);
  99
 100   // Get rid of trailing blanks in the name
 101   std::string mbrPath = mbr.getPath().str();
 102   size_t mbrLen = mbrPath.length();
 103   while (mbrLen > 0 && mbrPath[mbrLen-1] == ' ') {
 104     mbrPath.erase(mbrLen-1,1);
 105     mbrLen--;
 106   }
 107
 108   // Set the name field in one of its various flavors.
 109   bool writeLongName = false;
 110   if (mbr.isStringTable()) {
 111     memcpy(hdr.name,ARFILE_STRTAB_NAME,16);
 112   } else if (mbr.isSVR4SymbolTable()) {
 113     memcpy(hdr.name,ARFILE_SVR4_SYMTAB_NAME,16);
 114   } else if (mbr.isBSD4SymbolTable()) {
 115     memcpy(hdr.name,ARFILE_BSD4_SYMTAB_NAME,16);
 116   } else if (TruncateNames) {
 117     const char* nm = mbrPath.c_str();
 118     unsigned len = mbrPath.length();
 119     size_t slashpos = mbrPath.rfind('/');
 120     if (slashpos != std::string::npos) {
 121       nm += slashpos + 1;
 122       len -= slashpos +1;
 123     }
 124     if (len > 15)
 125       len = 15;
 126     memcpy(hdr.name,nm,len);
 127     hdr.name[len] = '/';
 128   } else if (mbrPath.length() < 16 && mbrPath.find('/') == std::string::npos) {
 129     memcpy(hdr.name,mbrPath.c_str(),mbrPath.length());
 130     hdr.name[mbrPath.length()] = '/';
 131   } else {
 132     std::string nm = "#1/";
 133     nm += utostr(mbrPath.length());
 134     memcpy(hdr.name,nm.data(),nm.length());
 135     if (sz < 0)
 136       sz -= mbrPath.length();
 137     else
 138       sz += mbrPath.length();
 139     writeLongName = true;
 140   }
 141
 142   // Set the size field
 143   if (sz < 0) {
 144     buffer[0] = '-';
 145     sprintf(&buffer[1],"%-9u",(unsigned)-sz);
 146   } else {
 147     sprintf(buffer, "%-10u", (unsigned)sz);
 148   }
 149   memcpy(hdr.size,buffer,10);
 150
 151   return writeLongName;
 152 }
 153
 154 // Insert a file into the archive before some other member. This also takes care
 155 // of extracting the necessary flags and information from the file.
 156 bool
 157 Archive::addFileBefore(const sys::Path& filePath, iterator where,
 158                         std::string* ErrMsg) {
 159   bool Exists;
 160   if (sys::fs::exists(filePath.str(), Exists) || !Exists) {
 161     if (ErrMsg)
 162       *ErrMsg = "Can not add a non-existent file to archive";
 163     return true;
 164   }
 165
 166   ArchiveMember* mbr = new ArchiveMember(this);
 167
 168   mbr->data = 0;
 169   mbr->path = filePath.str();
 170   sys::PathWithStatus PWS(mbr->path);
 171   const sys::FileStatus *FSInfo = PWS.getFileStatus(false, ErrMsg);
 172   if (!FSInfo) {
 173     delete mbr;
 174     return true;
 175   }
 176   mbr->info = *FSInfo;
 177
 178   unsigned flags = 0;
 179   bool hasSlash = filePath.str().find('/') != std::string::npos;
 180   if (hasSlash)
 181     flags |= ArchiveMember::HasPathFlag;
 182   if (hasSlash || filePath.str().length() > 15)
 183     flags |= ArchiveMember::HasLongFilenameFlag;
 184
 185   sys::fs::file_magic type;
 186   if (sys::fs::identify_magic(mbr->path, type))
 187     type = sys::fs::file_magic::unknown;
 188   switch (type) {
 189     case sys::fs::file_magic::bitcode:
 190       flags |= ArchiveMember::BitcodeFlag;
 191       break;
 192     default:
 193       break;
 194   }
 195   mbr->flags = flags;
 196   members.insert(where,mbr);
 197   return false;
 198 }
 199
 200 // Write one member out to the file.
 201 bool
 202 Archive::writeMember(
 203   const ArchiveMember& member,
 204   std::ofstream& ARFile,
 205   bool CreateSymbolTable,
 206   bool TruncateNames,
 207   std::string* ErrMsg
 208 ) {
 209
 210   unsigned filepos = ARFile.tellp();
 211   filepos -= 8;
 212
 213   // Get the data and its size either from the
 214   // member's in-memory data or directly from the file.
 215   size_t fSize = member.getSize();
 216   const char *data = (const char*)member.getData();
 217   MemoryBuffer *mFile = 0;
 218   if (!data) {
 219     OwningPtr<MemoryBuffer> File;
 220     if (error_code ec = MemoryBuffer::getFile(member.getPath(), File)) {
 221       if (ErrMsg)
 222         *ErrMsg = ec.message();
 223       return true;
 224     }
 225     mFile = File.take();
 226     data = mFile->getBufferStart();
 227     fSize = mFile->getBufferSize();
 228   }
 229
 230   // Now that we have the data in memory, update the
 231   // symbol table if it's a bitcode file.
 232   if (CreateSymbolTable && member.isBitcode()) {
 233     std::vector<std::string> symbols;
 234     std::string FullMemberName = archPath.str() + "(" + member.getPath().str()
 235       + ")";
 236     Module* M =
 237       GetBitcodeSymbols(data, fSize, FullMemberName, Context, symbols, ErrMsg);
 238
 239     // If the bitcode parsed successfully
 240     if ( M ) {
 241       for (std::vector<std::string>::iterator SI = symbols.begin(),
 242            SE = symbols.end(); SI != SE; ++SI) {
 243
 244         std::pair<SymTabType::iterator,bool> Res =
 245           symTab.insert(std::make_pair(*SI,filepos));
 246
 247         if (Res.second) {
 248           symTabSize += SI->length() +
 249                         numVbrBytes(SI->length()) +
 250                         numVbrBytes(filepos);
 251         }
 252       }
 253       // We don't need this module any more.
 254       delete M;
 255     } else {
 256       delete mFile;
 257       if (ErrMsg)
 258         *ErrMsg = "Can't parse bitcode member: " + member.getPath().str()
 259           + ": " + *ErrMsg;
 260       return true;
 261     }
 262   }
 263
 264   int hdrSize = fSize;
 265
 266   // Compute the fields of the header
 267   ArchiveMemberHeader Hdr;
 268   bool writeLongName = fillHeader(member,Hdr,hdrSize,TruncateNames);
 269
 270   // Write header to archive file
 271   ARFile.write((char*)&Hdr, sizeof(Hdr));
 272
 273   // Write the long filename if its long
 274   if (writeLongName) {
 275     ARFile.write(member.getPath().str().data(),
 276                  member.getPath().str().length());
 277   }
 278
 279   // Write the (possibly compressed) member's content to the file.
 280   ARFile.write(data,fSize);
 281
 282   // Make sure the member is an even length
 283   if ((ARFile.tellp() & 1) == 1)
 284     ARFile << ARFILE_PAD;
 285
 286   // Close the mapped file if it was opened
 287   delete mFile;
 288   return false;
 289 }
 290
 291 // Write the entire archive to the file specified when the archive was created.
 292 // This writes to a temporary file first. Options are for creating a symbol
 293 // table, flattening the file names (no directories, 15 chars max) and
 294 // compressing each archive member.
 295 bool
 296 Archive::writeToDisk(bool CreateSymbolTable, bool TruncateNames,
 297                      std::string* ErrMsg)
 298 {
 299   // Make sure they haven't opened up the file, not loaded it,
 300   // but are now trying to write it which would wipe out the file.
 301   if (members.empty() && mapfile && mapfile->getBufferSize() > 8) {
 302     if (ErrMsg)
 303       *ErrMsg = "Can't write an archive not opened for writing";
 304     return true;
 305   }
 306
 307   // Create a temporary file to store the archive in
 308   sys::Path TmpArchive = archPath;
 309   if (TmpArchive.createTemporaryFileOnDisk(ErrMsg))
 310     return true;
 311
 312   // Make sure the temporary gets removed if we crash
 313   sys::RemoveFileOnSignal(TmpArchive.str());
 314
 315   // Create archive file for output.
 316   std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
 317                                std::ios::binary;
 318   std::ofstream ArchiveFile(TmpArchive.c_str(), io_mode);
 319
 320   // Check for errors opening or creating archive file.
 321   if (!ArchiveFile.is_open() || ArchiveFile.bad()) {
 322     TmpArchive.eraseFromDisk();
 323     if (ErrMsg)
 324       *ErrMsg = "Error opening archive file: " + archPath.str();
 325     return true;
 326   }
 327
 328   // If we're creating a symbol table, reset it now
 329   if (CreateSymbolTable) {
 330     symTabSize = 0;
 331     symTab.clear();
 332   }
 333
 334   // Write magic string to archive.
 335   ArchiveFile << ARFILE_MAGIC;
 336
 337   // Loop over all member files, and write them out. Note that this also
 338   // builds the symbol table, symTab.
 339   for (MembersList::iterator I = begin(), E = end(); I != E; ++I) {
 340     if (writeMember(*I, ArchiveFile, CreateSymbolTable,
 341                      TruncateNames, ErrMsg)) {
 342       TmpArchive.eraseFromDisk();
 343       ArchiveFile.close();
 344       return true;
 345     }
 346   }
 347
 348   // Close archive file.
 349   ArchiveFile.close();
 350
 351   // Write the symbol table
 352   if (CreateSymbolTable) {
 353     // At this point we have written a file that is a legal archive but it
 354     // doesn't have a symbol table in it. To aid in faster reading and to
 355     // ensure compatibility with other archivers we need to put the symbol
 356     // table first in the file. Unfortunately, this means mapping the file
 357     // we just wrote back in and copying it to the destination file.
 358     sys::Path FinalFilePath = archPath;
 359
 360     // Map in the archive we just wrote.
 361     {
 362     OwningPtr<MemoryBuffer> arch;
 363     if (error_code ec = MemoryBuffer::getFile(TmpArchive.c_str(), arch)) {
 364       if (ErrMsg)
 365         *ErrMsg = ec.message();
 366       return true;
 367     }
 368     const char* base = arch->getBufferStart();
 369
 370     // Open another temporary file in order to avoid invalidating the
 371     // mmapped data
 372     if (FinalFilePath.createTemporaryFileOnDisk(ErrMsg))
 373       return true;
 374     sys::RemoveFileOnSignal(FinalFilePath.str());
 375
 376     std::ofstream FinalFile(FinalFilePath.c_str(), io_mode);
 377     if (!FinalFile.is_open() || FinalFile.bad()) {
 378       TmpArchive.eraseFromDisk();
 379       if (ErrMsg)
 380         *ErrMsg = "Error opening archive file: " + FinalFilePath.str();
 381       return true;
 382     }
 383
 384     // Write the file magic number
 385     FinalFile << ARFILE_MAGIC;
 386
 387     // If there is a foreign symbol table, put it into the file now. Most
 388     // ar(1) implementations require the symbol table to be first but llvm-ar
 389     // can deal with it being after a foreign symbol table. This ensures
 390     // compatibility with other ar(1) implementations as well as allowing the
 391     // archive to store both native .o and LLVM .bc files, both indexed.
 392     if (foreignST) {
 393       if (writeMember(*foreignST, FinalFile, false, false, ErrMsg)) {
 394         FinalFile.close();
 395         TmpArchive.eraseFromDisk();
 396         return true;
 397       }
 398     }
 399
 400     // Copy the temporary file contents being sure to skip the file's magic
 401     // number.
 402     FinalFile.write(base + sizeof(ARFILE_MAGIC)-1,
 403       arch->getBufferSize()-sizeof(ARFILE_MAGIC)+1);
 404
 405     // Close up shop
 406     FinalFile.close();
 407     } // free arch.
 408
 409     // Move the final file over top of TmpArchive
 410     if (FinalFilePath.renamePathOnDisk(TmpArchive, ErrMsg))
 411       return true;
 412   }
 413
 414   // Before we replace the actual archive, we need to forget all the
 415   // members, since they point to data in that old archive. We need to do
 416   // this because we cannot replace an open file on Windows.
 417   cleanUpMemory();
 418
 419   if (TmpArchive.renamePathOnDisk(archPath, ErrMsg))
 420     return true;
 421
 422   // Set correct read and write permissions after temporary file is moved
 423   // to final destination path.
 424   if (archPath.makeReadableOnDisk(ErrMsg))
 425     return true;
 426   if (archPath.makeWriteableOnDisk(ErrMsg))
 427     return true;
 428
 429   return false;
 430 }