lib/Archive/ArchiveWriter.cpp

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