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