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 <iostream>
  21 #include <iomanip>
  22
  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,false);
  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 void
 155 Archive::addFileBefore(const sys::Path& filePath, iterator where) {
 156   assert(filePath.exists() && "Can't add a non-existent file");
 157
 158   ArchiveMember* mbr = new ArchiveMember(this);
 159
 160   mbr->data = 0;
 161   mbr->path = filePath;
 162   mbr->path.getStatusInfo(mbr->info);
 163
 164   unsigned flags = 0;
 165   bool hasSlash = filePath.toString().find('/') != std::string::npos;
 166   if (hasSlash)
 167     flags |= ArchiveMember::HasPathFlag;
 168   if (hasSlash || filePath.toString().length() > 15)
 169     flags |= ArchiveMember::HasLongFilenameFlag;
 170   std::string magic;
 171   mbr->path.getMagicNumber(magic,4);
 172   switch (sys::IdentifyFileType(magic.c_str(),4)) {
 173     case sys::BytecodeFileType:
 174       flags |= ArchiveMember::BytecodeFlag;
 175       break;
 176     case sys::CompressedBytecodeFileType:
 177       flags |= ArchiveMember::CompressedBytecodeFlag;
 178       break;
 179     default:
 180       break;
 181   }
 182   mbr->flags = flags;
 183   members.insert(where,mbr);
 184 }
 185
 186 // Write one member out to the file.
 187 void
 188 Archive::writeMember(
 189   const ArchiveMember& member,
 190   std::ofstream& ARFile,
 191   bool CreateSymbolTable,
 192   bool TruncateNames,
 193   bool ShouldCompress
 194 ) {
 195
 196   unsigned filepos = ARFile.tellp();
 197   filepos -= 8;
 198
 199   // Get the data and its size either from the
 200   // member's in-memory data or directly from the file.
 201   size_t fSize = member.getSize();
 202   const char* data = (const char*)member.getData();
 203   sys::MappedFile* mFile = 0;
 204   if (!data) {
 205     mFile = new sys::MappedFile(member.getPath());
 206     data = (const char*) mFile->map();
 207     fSize = mFile->size();
 208   }
 209
 210   // Now that we have the data in memory, update the
 211   // symbol table if its a bytecode file.
 212   if (CreateSymbolTable &&
 213       (member.isBytecode() || member.isCompressedBytecode())) {
 214     std::vector<std::string> symbols;
 215     std::string FullMemberName = archPath.toString() + "(" +
 216       member.getPath().toString()
 217       + ")";
 218     ModuleProvider* MP = GetBytecodeSymbols(
 219       (const unsigned char*)data,fSize,FullMemberName, symbols);
 220
 221     // If the bytecode parsed successfully
 222     if ( MP ) {
 223       for (std::vector<std::string>::iterator SI = symbols.begin(),
 224            SE = symbols.end(); SI != SE; ++SI) {
 225
 226         std::pair<SymTabType::iterator,bool> Res =
 227           symTab.insert(std::make_pair(*SI,filepos));
 228
 229         if (Res.second) {
 230           symTabSize += SI->length() +
 231                         numVbrBytes(SI->length()) +
 232                         numVbrBytes(filepos);
 233         }
 234       }
 235       // We don't need this module any more.
 236       delete MP;
 237     } else {
 238       throw std::string("Can't parse bytecode member: ") +
 239              member.getPath().toString();
 240     }
 241   }
 242
 243   // Determine if we actually should compress this member
 244   bool willCompress =
 245       (ShouldCompress &&
 246       !member.isCompressed() &&
 247       !member.isCompressedBytecode() &&
 248       !member.isLLVMSymbolTable() &&
 249       !member.isSVR4SymbolTable() &&
 250       !member.isBSD4SymbolTable());
 251
 252   // Perform the compression. Note that if the file is uncompressed bytecode
 253   // then we turn the file into compressed bytecode rather than treating it as
 254   // compressed data. This is necessary since it allows us to determine that the
 255   // file contains bytecode instead of looking like a regular compressed data
 256   // member. A compressed bytecode file has its content compressed but has a
 257   // magic number of "llvc". This acounts for the +/-4 arithmetic in the code
 258   // below.
 259   int hdrSize;
 260   if (willCompress) {
 261     char* output = 0;
 262     if (member.isBytecode()) {
 263       data +=4;
 264       fSize -= 4;
 265     }
 266     fSize = Compressor::compressToNewBuffer(data,fSize,output);
 267     data = output;
 268     if (member.isBytecode())
 269       hdrSize = -fSize-4;
 270     else
 271       hdrSize = -fSize;
 272   } else {
 273     hdrSize = fSize;
 274   }
 275
 276   // Compute the fields of the header
 277   ArchiveMemberHeader Hdr;
 278   bool writeLongName = fillHeader(member,Hdr,hdrSize,TruncateNames);
 279
 280   // Write header to archive file
 281   ARFile.write((char*)&Hdr, sizeof(Hdr));
 282
 283   // Write the long filename if its long
 284   if (writeLongName) {
 285     ARFile.write(member.getPath().toString().data(),
 286                  member.getPath().toString().length());
 287   }
 288
 289   // Make sure we write the compressed bytecode magic number if we should.
 290   if (willCompress && member.isBytecode())
 291     ARFile.write("llvc",4);
 292
 293   // Write the (possibly compressed) member's content to the file.
 294   ARFile.write(data,fSize);
 295
 296   // Make sure the member is an even length
 297   if ((ARFile.tellp() & 1) == 1)
 298     ARFile << ARFILE_PAD;
 299
 300   // Free the compressed data, if necessary
 301   if (willCompress) {
 302     free((void*)data);
 303   }
 304
 305   // Close the mapped file if it was opened
 306   if (mFile != 0) {
 307     mFile->close();
 308     delete mFile;
 309   }
 310 }
 311
 312 // Write out the LLVM symbol table as an archive member to the file.
 313 void
 314 Archive::writeSymbolTable(std::ofstream& ARFile) {
 315
 316   // Construct the symbol table's header
 317   ArchiveMemberHeader Hdr;
 318   Hdr.init();
 319   memcpy(Hdr.name,ARFILE_LLVM_SYMTAB_NAME,16);
 320   uint64_t secondsSinceEpoch = sys::TimeValue::now().toEpochTime();
 321   char buffer[32];
 322   sprintf(buffer, "%-8o", 0644);
 323   memcpy(Hdr.mode,buffer,8);
 324   sprintf(buffer, "%-6u", sys::Process::GetCurrentUserId());
 325   memcpy(Hdr.uid,buffer,6);
 326   sprintf(buffer, "%-6u", sys::Process::GetCurrentGroupId());
 327   memcpy(Hdr.gid,buffer,6);
 328   sprintf(buffer,"%-12u", unsigned(secondsSinceEpoch));
 329   memcpy(Hdr.date,buffer,12);
 330   sprintf(buffer,"%-10u",symTabSize);
 331   memcpy(Hdr.size,buffer,10);
 332
 333   // Write the header
 334   ARFile.write((char*)&Hdr, sizeof(Hdr));
 335
 336   // Save the starting position of the symbol tables data content.
 337   unsigned startpos = ARFile.tellp();
 338
 339   // Write out the symbols sequentially
 340   for ( Archive::SymTabType::iterator I = symTab.begin(), E = symTab.end();
 341         I != E; ++I)
 342   {
 343     // Write out the file index
 344     writeInteger(I->second, ARFile);
 345     // Write out the length of the symbol
 346     writeInteger(I->first.length(), ARFile);
 347     // Write out the symbol
 348     ARFile.write(I->first.data(), I->first.length());
 349   }
 350
 351   // Now that we're done with the symbol table, get the ending file position
 352   unsigned endpos = ARFile.tellp();
 353
 354   // Make sure that the amount we wrote is what we pre-computed. This is
 355   // critical for file integrity purposes.
 356   assert(endpos - startpos == symTabSize && "Invalid symTabSize computation");
 357
 358   // Make sure the symbol table is even sized
 359   if (symTabSize % 2 != 0 )
 360     ARFile << ARFILE_PAD;
 361 }
 362
 363 // Write the entire archive to the file specified when the archive was created.
 364 // This writes to a temporary file first. Options are for creating a symbol
 365 // table, flattening the file names (no directories, 15 chars max) and
 366 // compressing each archive member.
 367 void
 368 Archive::writeToDisk(bool CreateSymbolTable, bool TruncateNames, bool Compress){
 369
 370   // Make sure they haven't opened up the file, not loaded it,
 371   // but are now trying to write it which would wipe out the file.
 372   assert(!(members.empty() && mapfile->size() > 8) &&
 373          "Can't write an archive not opened for writing");
 374
 375   // Create a temporary file to store the archive in
 376   sys::Path TmpArchive = archPath;
 377   TmpArchive.createTemporaryFileOnDisk();
 378
 379   // Make sure the temporary gets removed if we crash
 380   sys::RemoveFileOnSignal(TmpArchive);
 381
 382   // Ensure we can remove the temporary even in the face of an exception
 383   try {
 384     // Create archive file for output.
 385     std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
 386                                  std::ios::binary;
 387     std::ofstream ArchiveFile(TmpArchive.c_str(), io_mode);
 388
 389     // Check for errors opening or creating archive file.
 390     if ( !ArchiveFile.is_open() || ArchiveFile.bad() ) {
 391       throw std::string("Error opening archive file: ") + archPath.toString();
 392     }
 393
 394     // If we're creating a symbol table, reset it now
 395     if (CreateSymbolTable) {
 396       symTabSize = 0;
 397       symTab.clear();
 398     }
 399
 400     // Write magic string to archive.
 401     ArchiveFile << ARFILE_MAGIC;
 402
 403     // Loop over all member files, and write them out. Note that this also
 404     // builds the symbol table, symTab.
 405     for ( MembersList::iterator I = begin(), E = end(); I != E; ++I) {
 406       writeMember(*I,ArchiveFile,CreateSymbolTable,TruncateNames,Compress);
 407     }
 408
 409     // Close archive file.
 410     ArchiveFile.close();
 411
 412     // Write the symbol table
 413     if (CreateSymbolTable) {
 414       // At this point we have written a file that is a legal archive but it
 415       // doesn't have a symbol table in it. To aid in faster reading and to
 416       // ensure compatibility with other archivers we need to put the symbol
 417       // table first in the file. Unfortunately, this means mapping the file
 418       // we just wrote back in and copying it to the destination file.
 419
 420       // Map in the archive we just wrote.
 421       sys::MappedFile arch(TmpArchive);
 422       const char* base = (const char*) arch.map();
 423
 424       // Open another temporary file in order to avoid invalidating the mmapped data
 425       sys::Path FinalFilePath = archPath;
 426       FinalFilePath.createTemporaryFileOnDisk();
 427       sys::RemoveFileOnSignal(FinalFilePath);
 428       try {
 429
 430
 431         std::ofstream FinalFile(FinalFilePath.c_str(), io_mode);
 432         if ( !FinalFile.is_open() || FinalFile.bad() ) {
 433           throw std::string("Error opening archive file: ") + FinalFilePath.toString();
 434         }
 435
 436         // Write the file magic number
 437         FinalFile << ARFILE_MAGIC;
 438
 439         // If there is a foreign symbol table, put it into the file now. Most
 440         // ar(1) implementations require the symbol table to be first but llvm-ar
 441         // can deal with it being after a foreign symbol table. This ensures
 442         // compatibility with other ar(1) implementations as well as allowing the
 443         // archive to store both native .o and LLVM .bc files, both indexed.
 444         if (foreignST) {
 445           writeMember(*foreignST, FinalFile, false, false, false);
 446         }
 447
 448         // Put out the LLVM symbol table now.
 449         writeSymbolTable(FinalFile);
 450
 451         // Copy the temporary file contents being sure to skip the file's magic
 452         // number.
 453         FinalFile.write(base + sizeof(ARFILE_MAGIC)-1,
 454           arch.size()-sizeof(ARFILE_MAGIC)+1);
 455
 456         // Close up shop
 457         FinalFile.close();
 458         arch.close();
 459
 460         // Move the final file over top of TmpArchive
 461         FinalFilePath.renamePathOnDisk(TmpArchive);
 462       } catch (...) {
 463         // Make sure we clean up.
 464         if (FinalFilePath.exists())
 465           FinalFilePath.eraseFromDisk();
 466         throw;
 467       }
 468     }
 469
 470     // Before we replace the actual archive, we need to forget all the
 471     // members, since they point to data in that old archive. We need to do
 472     // we cannot replace an open file on Windows.
 473     cleanUpMemory();
 474
 475     TmpArchive.renamePathOnDisk(archPath);
 476   } catch (...) {
 477     // Make sure we clean up.
 478     if (TmpArchive.exists())
 479       TmpArchive.eraseFromDisk();
 480     throw;
 481   }
 482 }