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/FileUtilities.h"
  17 #include "llvm/Support/Compressor.h"
  18 #include "llvm/System/Signals.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   // Set the name field in one of its various flavors.
  97   bool writeLongName = false;
  98   const std::string& mbrPath = mbr.getPath().get();
  99   if (mbr.isStringTable()) {
 100     memcpy(hdr.name,ARFILE_STRTAB_NAME,16);
 101   } else if (mbr.isForeignSymbolTable()) {
 102     memcpy(hdr.name,ARFILE_SYMTAB_NAME,16);
 103   } else if (mbr.isLLVMSymbolTable()) {
 104     memcpy(hdr.name,ARFILE_LLVM_SYMTAB_NAME,16);
 105   } else if (TruncateNames) {
 106     const char* nm = mbrPath.c_str();
 107     unsigned len = mbrPath.length();
 108     size_t slashpos = mbrPath.rfind('/');
 109     if (slashpos != std::string::npos) {
 110       nm += slashpos + 1;
 111       len -= slashpos +1;
 112     }
 113     if (len > 15)
 114       len = 15;
 115     memcpy(hdr.name,nm,len);
 116     hdr.name[len] = '/';
 117   } else if (mbrPath.length() < 16 && mbrPath.find('/') == std::string::npos) {
 118     mbrPath.copy(hdr.name,mbrPath.length());
 119     hdr.name[mbrPath.length()] = '/';
 120   } else {
 121     std::string nm = "#1/";
 122     nm += utostr(mbrPath.length());
 123     nm.copy(hdr.name,nm.length());
 124     if (sz < 0)
 125       sz -= mbrPath.length();
 126     else
 127       sz += mbrPath.length();
 128     writeLongName = true;
 129   }
 130
 131   // Set the size field
 132   if (sz < 0) {
 133     buffer[0] = '-';
 134     sprintf(&buffer[1],"%-9u",(unsigned)-sz);
 135   } else {
 136     sprintf(buffer, "%-10u", (unsigned)sz);
 137   }
 138   memcpy(hdr.size,buffer,10);
 139
 140   return writeLongName;
 141 }
 142
 143 // Insert a file into the archive before some other member. This also takes care
 144 // of extracting the necessary flags and information from the file.
 145 void
 146 Archive::addFileBefore(const sys::Path& filePath, iterator where) {
 147   assert(filePath.exists() && "Can't add a non-existent file");
 148
 149   ArchiveMember* mbr = new ArchiveMember(this);
 150
 151   mbr->data = 0;
 152   mbr->path = filePath;
 153   mbr->path.getStatusInfo(mbr->info);
 154
 155   unsigned flags = 0;
 156   bool hasSlash = filePath.get().find('/') != std::string::npos;
 157   if (hasSlash)
 158     flags |= ArchiveMember::HasPathFlag;
 159   if (hasSlash || filePath.get().length() > 15)
 160     flags |= ArchiveMember::HasLongFilenameFlag;
 161   std::string magic;
 162   mbr->path.getMagicNumber(magic,4);
 163   switch (sys::IdentifyFileType(magic.c_str(),4)) {
 164     case sys::BytecodeFileType:
 165       flags |= ArchiveMember::BytecodeFlag;
 166       break;
 167     case sys::CompressedBytecodeFileType:
 168       flags |= ArchiveMember::CompressedBytecodeFlag;
 169       break;
 170     default:
 171       break;
 172   }
 173   mbr->flags = flags;
 174   members.insert(where,mbr);
 175 }
 176
 177 // Write one member out to the file.
 178 void
 179 Archive::writeMember(
 180   const ArchiveMember& member,
 181   std::ofstream& ARFile,
 182   bool CreateSymbolTable,
 183   bool TruncateNames,
 184   bool ShouldCompress
 185 ) {
 186
 187   unsigned filepos = ARFile.tellp();
 188   filepos -= 8;
 189
 190   // Get the data and its size either from the
 191   // member's in-memory data or directly from the file.
 192   size_t fSize = member.getSize();
 193   const char* data = (const char*)member.getData();
 194   sys::MappedFile* mFile = 0;
 195   if (!data) {
 196     mFile = new sys::MappedFile(member.getPath());
 197     data = (const char*) mFile->map();
 198     fSize = mFile->size();
 199   }
 200
 201   // Now that we have the data in memory, update the
 202   // symbol table if its a bytecode file.
 203   if (CreateSymbolTable &&
 204       (member.isBytecode() || member.isCompressedBytecode())) {
 205     std::vector<std::string> symbols;
 206     ModuleProvider* MP = GetBytecodeSymbols(
 207       (const unsigned char*)data,fSize,member.getPath().get(), symbols);
 208
 209     // If the bytecode parsed successfully
 210     if ( MP ) {
 211       for (std::vector<std::string>::iterator SI = symbols.begin(),
 212            SE = symbols.end(); SI != SE; ++SI) {
 213
 214         std::pair<SymTabType::iterator,bool> Res =
 215           symTab.insert(std::make_pair(*SI,filepos));
 216
 217         if (Res.second) {
 218           symTabSize += SI->length() +
 219                         numVbrBytes(SI->length()) +
 220                         numVbrBytes(filepos);
 221         }
 222       }
 223       // We don't need this module any more.
 224       delete MP;
 225     } else {
 226       throw std::string("Can't parse bytecode member: ") +
 227              member.getPath().get();
 228     }
 229   }
 230
 231   // Determine if we actually should compress this member
 232   bool willCompress =
 233       (ShouldCompress &&
 234       !member.isForeignSymbolTable() &&
 235       !member.isLLVMSymbolTable() &&
 236       !member.isCompressed() &&
 237       !member.isCompressedBytecode());
 238
 239   // Perform the compression. Note that if the file is uncompressed bytecode
 240   // then we turn the file into compressed bytecode rather than treating it as
 241   // compressed data. This is necessary since it allows us to determine that the
 242   // file contains bytecode instead of looking like a regular compressed data
 243   // member. A compressed bytecode file has its content compressed but has a
 244   // magic number of "llvc". This acounts for the +/-4 arithmetic in the code
 245   // below.
 246   int hdrSize;
 247   if (willCompress) {
 248     char* output = 0;
 249     if (member.isBytecode()) {
 250       data +=4;
 251       fSize -= 4;
 252     }
 253     fSize = Compressor::compressToNewBuffer(
 254               data,fSize,output,Compressor::COMP_TYPE_ZLIB);
 255     data = output;
 256     if (member.isBytecode())
 257       hdrSize = -fSize-4;
 258     else
 259       hdrSize = -fSize;
 260   } else {
 261     hdrSize = fSize;
 262   }
 263
 264   // Compute the fields of the header
 265   ArchiveMemberHeader Hdr;
 266   bool writeLongName = fillHeader(member,Hdr,hdrSize,TruncateNames);
 267
 268   // Write header to archive file
 269   ARFile.write((char*)&Hdr, sizeof(Hdr));
 270
 271   // Write the long filename if its long
 272   if (writeLongName) {
 273     ARFile << member.getPath().c_str();
 274   }
 275
 276   // Make sure we write the compressed bytecode magic number if we should.
 277   if (willCompress && member.isBytecode())
 278     ARFile.write("llvc",4);
 279
 280   // Write the (possibly compressed) member's content to the file.
 281   ARFile.write(data,fSize);
 282
 283   // Make sure the member is an even length
 284   if (ARFile.tellp() % 2 != 0)
 285     ARFile << ARFILE_PAD;
 286
 287   // Free the compressed data, if necessary
 288   if (willCompress) {
 289     free((void*)data);
 290   }
 291
 292   // Close the mapped file if it was opened
 293   if (mFile != 0) {
 294     mFile->unmap();
 295     delete mFile;
 296   }
 297 }
 298
 299 // Write out the LLVM symbol table as an archive member to the file.
 300 void
 301 Archive::writeSymbolTable(std::ofstream& ARFile) {
 302
 303   // Construct the symbol table's header
 304   ArchiveMemberHeader Hdr;
 305   Hdr.init();
 306   memcpy(Hdr.name,ARFILE_LLVM_SYMTAB_NAME,16);
 307   uint64_t secondsSinceEpoch = sys::TimeValue::now().toEpochTime();
 308   char buffer[32];
 309   sprintf(buffer,"%-12u", unsigned(secondsSinceEpoch));
 310   memcpy(Hdr.date,buffer,12);
 311   sprintf(buffer,"%-10u",symTabSize);
 312   memcpy(Hdr.size,buffer,10);
 313
 314   // Write the header
 315   ARFile.write((char*)&Hdr, sizeof(Hdr));
 316
 317   // Save the starting position of the symbol tables data content.
 318   unsigned startpos = ARFile.tellp();
 319
 320   // Write out the symbols sequentially
 321   for ( Archive::SymTabType::iterator I = symTab.begin(), E = symTab.end();
 322         I != E; ++I)
 323   {
 324     // Write out the file index
 325     writeInteger(I->second, ARFile);
 326     // Write out the length of the symbol
 327     writeInteger(I->first.length(), ARFile);
 328     // Write out the symbol
 329     ARFile.write(I->first.data(), I->first.length());
 330   }
 331
 332   // Now that we're done with the symbol table, get the ending file position
 333   unsigned endpos = ARFile.tellp();
 334
 335   // Make sure that the amount we wrote is what we pre-computed. This is
 336   // critical for file integrity purposes.
 337   assert(endpos - startpos == symTabSize && "Invalid symTabSize computation");
 338
 339   // Make sure the symbol table is even sized
 340   if (symTabSize % 2 != 0 )
 341     ARFile << ARFILE_PAD;
 342 }
 343
 344 // Write the entire archive to the file specified when the archive was created.
 345 // This writes to a temporary file first. Options are for creating a symbol
 346 // table, flattening the file names (no directories, 15 chars max) and
 347 // compressing each archive member.
 348 void
 349 Archive::writeToDisk(bool CreateSymbolTable, bool TruncateNames, bool Compress){
 350
 351   // Make sure they haven't opened up the file, not loaded it,
 352   // but are now trying to write it which would wipe out the file.
 353   assert(!(members.empty() && mapfile->size() > 8) &&
 354          "Can't write an archive not opened for writing");
 355
 356   // Create a temporary file to store the archive in
 357   sys::Path TmpArchive = archPath;
 358   TmpArchive.createTemporaryFile();
 359
 360   // Make sure the temporary gets removed if we crash
 361   sys::RemoveFileOnSignal(TmpArchive);
 362
 363   // Ensure we can remove the temporary even in the face of an exception
 364   try {
 365     // Create archive file for output.
 366     std::ofstream ArchiveFile(TmpArchive.c_str());
 367
 368     // Check for errors opening or creating archive file.
 369     if ( !ArchiveFile.is_open() || ArchiveFile.bad() ) {
 370       throw std::string("Error opening archive file: ") + archPath.get();
 371     }
 372
 373     // If we're creating a symbol table, reset it now
 374     if (CreateSymbolTable) {
 375       symTabSize = 0;
 376       symTab.clear();
 377     }
 378
 379     // Write magic string to archive.
 380     ArchiveFile << ARFILE_MAGIC;
 381
 382     // Loop over all member files, and write them out. Note that this also
 383     // builds the symbol table, symTab.
 384     for ( MembersList::iterator I = begin(), E = end(); I != E; ++I) {
 385       writeMember(*I,ArchiveFile,CreateSymbolTable,TruncateNames,Compress);
 386     }
 387
 388     // Close archive file.
 389     ArchiveFile.close();
 390
 391     // Write the symbol table
 392     if (CreateSymbolTable) {
 393       // At this point we have written a file that is a legal archive but it
 394       // doesn't have a symbol table in it. To aid in faster reading and to
 395       // ensure compatibility with other archivers we need to put the symbol
 396       // table first in the file. Unfortunately, this means mapping the file
 397       // we just wrote back in and copying it to the destination file.
 398
 399       // Map in the archive we just wrote.
 400       sys::MappedFile arch(TmpArchive);
 401       const char* base = (const char*) arch.map();
 402
 403       // Open the final file to write and check it.
 404       std::ofstream FinalFile(archPath.c_str());
 405       if ( !FinalFile.is_open() || FinalFile.bad() ) {
 406         throw std::string("Error opening archive file: ") + archPath.get();
 407       }
 408
 409       // Write the file magic number
 410       FinalFile << ARFILE_MAGIC;
 411
 412       // If there is a foreign symbol table, put it into the file now.
 413       if (foreignST) {
 414         writeMember(*foreignST, FinalFile, false, false, false);
 415       }
 416
 417       // Put out the LLVM symbol table now.
 418       writeSymbolTable(FinalFile);
 419
 420       // Copy the temporary file contents being sure to skip the file's magic
 421       // number.
 422       FinalFile.write(base + sizeof(ARFILE_MAGIC)-1,
 423         arch.size()-sizeof(ARFILE_MAGIC)+1);
 424
 425       // Close up shop
 426       FinalFile.close();
 427       arch.unmap();
 428       TmpArchive.destroyFile();
 429
 430     } else {
 431       // We don't have to insert the symbol table, so just renaming the temp
 432       // file to the correct name will suffice.
 433       TmpArchive.renameFile(archPath);
 434     }
 435   } catch (...) {
 436     // Make sure we clean up.
 437     if (TmpArchive.exists())
 438       TmpArchive.destroyFile();
 439     throw;
 440   }
 441 }