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(StringRef 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 Archive::addFileBefore(StringRef filePath, iterator where,
 157                             std::string *ErrMsg) {
 158   bool Exists;
 159   if (sys::fs::exists(filePath.str(), Exists) || !Exists) {
 160     if (ErrMsg)
 161       *ErrMsg = "Can not add a non-existent file to archive";
 162     return true;
 163   }
 164
 165   ArchiveMember* mbr = new ArchiveMember(this);
 166
 167   mbr->data = 0;
 168   mbr->path = filePath.str();
 169   sys::PathWithStatus PWS(mbr->path);
 170   const sys::FileStatus *FSInfo = PWS.getFileStatus(false, ErrMsg);
 171   if (!FSInfo) {
 172     delete mbr;
 173     return true;
 174   }
 175   mbr->User = FSInfo->getUser();
 176   mbr->Group = FSInfo->getGroup();
 177   mbr->Mode = FSInfo->getMode();
 178   mbr->ModTime = FSInfo->getTimestamp();
 179   mbr->Size = FSInfo->getSize();
 180
 181   unsigned flags = 0;
 182   bool hasSlash = filePath.str().find('/') != std::string::npos;
 183   if (hasSlash)
 184     flags |= ArchiveMember::HasPathFlag;
 185   if (hasSlash || filePath.str().length() > 15)
 186     flags |= ArchiveMember::HasLongFilenameFlag;
 187
 188   sys::fs::file_magic type;
 189   if (sys::fs::identify_magic(mbr->path, type))
 190     type = sys::fs::file_magic::unknown;
 191   switch (type) {
 192     case sys::fs::file_magic::bitcode:
 193       flags |= ArchiveMember::BitcodeFlag;
 194       break;
 195     default:
 196       break;
 197   }
 198   mbr->flags = flags;
 199   members.insert(where,mbr);
 200   return false;
 201 }
 202
 203 // Write one member out to the file.
 204 bool
 205 Archive::writeMember(
 206   const ArchiveMember& member,
 207   std::ofstream& ARFile,
 208   bool CreateSymbolTable,
 209   bool TruncateNames,
 210   std::string* ErrMsg
 211 ) {
 212
 213   unsigned filepos = ARFile.tellp();
 214   filepos -= 8;
 215
 216   // Get the data and its size either from the
 217   // member's in-memory data or directly from the file.
 218   size_t fSize = member.getSize();
 219   const char *data = (const char*)member.getData();
 220   MemoryBuffer *mFile = 0;
 221   if (!data) {
 222     OwningPtr<MemoryBuffer> File;
 223     if (error_code ec = MemoryBuffer::getFile(member.getPath(), File)) {
 224       if (ErrMsg)
 225         *ErrMsg = ec.message();
 226       return true;
 227     }
 228     mFile = File.take();
 229     data = mFile->getBufferStart();
 230     fSize = mFile->getBufferSize();
 231   }
 232
 233   // Now that we have the data in memory, update the
 234   // symbol table if it's a bitcode file.
 235   if (CreateSymbolTable && member.isBitcode()) {
 236     std::vector<std::string> symbols;
 237     std::string FullMemberName =
 238         (archPath + "(" + member.getPath() + ")").str();
 239     Module* M =
 240       GetBitcodeSymbols(data, fSize, FullMemberName, Context, symbols, ErrMsg);
 241
 242     // If the bitcode parsed successfully
 243     if ( M ) {
 244       for (std::vector<std::string>::iterator SI = symbols.begin(),
 245            SE = symbols.end(); SI != SE; ++SI) {
 246
 247         std::pair<SymTabType::iterator,bool> Res =
 248           symTab.insert(std::make_pair(*SI,filepos));
 249
 250         if (Res.second) {
 251           symTabSize += SI->length() +
 252                         numVbrBytes(SI->length()) +
 253                         numVbrBytes(filepos);
 254         }
 255       }
 256       // We don't need this module any more.
 257       delete M;
 258     } else {
 259       delete mFile;
 260       if (ErrMsg)
 261         *ErrMsg = "Can't parse bitcode member: " + member.getPath().str()
 262           + ": " + *ErrMsg;
 263       return true;
 264     }
 265   }
 266
 267   int hdrSize = fSize;
 268
 269   // Compute the fields of the header
 270   ArchiveMemberHeader Hdr;
 271   bool writeLongName = fillHeader(member,Hdr,hdrSize,TruncateNames);
 272
 273   // Write header to archive file
 274   ARFile.write((char*)&Hdr, sizeof(Hdr));
 275
 276   // Write the long filename if its long
 277   if (writeLongName) {
 278     ARFile.write(member.getPath().str().data(),
 279                  member.getPath().str().length());
 280   }
 281
 282   // Write the (possibly compressed) member's content to the file.
 283   ARFile.write(data,fSize);
 284
 285   // Make sure the member is an even length
 286   if ((ARFile.tellp() & 1) == 1)
 287     ARFile << ARFILE_PAD;
 288
 289   // Close the mapped file if it was opened
 290   delete mFile;
 291   return false;
 292 }
 293
 294 // Write the entire archive to the file specified when the archive was created.
 295 // This writes to a temporary file first. Options are for creating a symbol
 296 // table, flattening the file names (no directories, 15 chars max) and
 297 // compressing each archive member.
 298 bool
 299 Archive::writeToDisk(bool CreateSymbolTable, bool TruncateNames,
 300                      std::string* ErrMsg)
 301 {
 302   // Make sure they haven't opened up the file, not loaded it,
 303   // but are now trying to write it which would wipe out the file.
 304   if (members.empty() && mapfile && mapfile->getBufferSize() > 8) {
 305     if (ErrMsg)
 306       *ErrMsg = "Can't write an archive not opened for writing";
 307     return true;
 308   }
 309
 310   // Create a temporary file to store the archive in
 311   sys::Path TmpArchive(archPath);
 312   if (TmpArchive.createTemporaryFileOnDisk(ErrMsg))
 313     return true;
 314
 315   // Make sure the temporary gets removed if we crash
 316   sys::RemoveFileOnSignal(TmpArchive.str());
 317
 318   // Create archive file for output.
 319   std::ios::openmode io_mode = std::ios::out | std::ios::trunc |
 320                                std::ios::binary;
 321   std::ofstream ArchiveFile(TmpArchive.c_str(), io_mode);
 322
 323   // Check for errors opening or creating archive file.
 324   if (!ArchiveFile.is_open() || ArchiveFile.bad()) {
 325     TmpArchive.eraseFromDisk();
 326     if (ErrMsg)
 327       *ErrMsg = "Error opening archive file: " + archPath;
 328     return true;
 329   }
 330
 331   // If we're creating a symbol table, reset it now
 332   if (CreateSymbolTable) {
 333     symTabSize = 0;
 334     symTab.clear();
 335   }
 336
 337   // Write magic string to archive.
 338   ArchiveFile << ARFILE_MAGIC;
 339
 340   // Loop over all member files, and write them out. Note that this also
 341   // builds the symbol table, symTab.
 342   for (MembersList::iterator I = begin(), E = end(); I != E; ++I) {
 343     if (writeMember(*I, ArchiveFile, CreateSymbolTable,
 344                      TruncateNames, ErrMsg)) {
 345       TmpArchive.eraseFromDisk();
 346       ArchiveFile.close();
 347       return true;
 348     }
 349   }
 350
 351   // Close archive file.
 352   ArchiveFile.close();
 353
 354   // Write the symbol table
 355   if (CreateSymbolTable) {
 356     // At this point we have written a file that is a legal archive but it
 357     // doesn't have a symbol table in it. To aid in faster reading and to
 358     // ensure compatibility with other archivers we need to put the symbol
 359     // table first in the file. Unfortunately, this means mapping the file
 360     // we just wrote back in and copying it to the destination file.
 361     sys::Path FinalFilePath(archPath);
 362
 363     // Map in the archive we just wrote.
 364     {
 365     OwningPtr<MemoryBuffer> arch;
 366     if (error_code ec = MemoryBuffer::getFile(TmpArchive.c_str(), arch)) {
 367       if (ErrMsg)
 368         *ErrMsg = ec.message();
 369       return true;
 370     }
 371     const char* base = arch->getBufferStart();
 372
 373     // Open another temporary file in order to avoid invalidating the
 374     // mmapped data
 375     if (FinalFilePath.createTemporaryFileOnDisk(ErrMsg))
 376       return true;
 377     sys::RemoveFileOnSignal(FinalFilePath.str());
 378
 379     std::ofstream FinalFile(FinalFilePath.c_str(), io_mode);
 380     if (!FinalFile.is_open() || FinalFile.bad()) {
 381       TmpArchive.eraseFromDisk();
 382       if (ErrMsg)
 383         *ErrMsg = "Error opening archive file: " + FinalFilePath.str();
 384       return true;
 385     }
 386
 387     // Write the file magic number
 388     FinalFile << ARFILE_MAGIC;
 389
 390     // If there is a foreign symbol table, put it into the file now. Most
 391     // ar(1) implementations require the symbol table to be first but llvm-ar
 392     // can deal with it being after a foreign symbol table. This ensures
 393     // compatibility with other ar(1) implementations as well as allowing the
 394     // archive to store both native .o and LLVM .bc files, both indexed.
 395     if (foreignST) {
 396       if (writeMember(*foreignST, FinalFile, false, false, ErrMsg)) {
 397         FinalFile.close();
 398         TmpArchive.eraseFromDisk();
 399         return true;
 400       }
 401     }
 402
 403     // Copy the temporary file contents being sure to skip the file's magic
 404     // number.
 405     FinalFile.write(base + sizeof(ARFILE_MAGIC)-1,
 406       arch->getBufferSize()-sizeof(ARFILE_MAGIC)+1);
 407
 408     // Close up shop
 409     FinalFile.close();
 410     } // free arch.
 411
 412     // Move the final file over top of TmpArchive
 413     if (FinalFilePath.renamePathOnDisk(TmpArchive, ErrMsg))
 414       return true;
 415   }
 416
 417   // Before we replace the actual archive, we need to forget all the
 418   // members, since they point to data in that old archive. We need to do
 419   // this because we cannot replace an open file on Windows.
 420   cleanUpMemory();
 421
 422   if (TmpArchive.renamePathOnDisk(sys::Path(archPath), ErrMsg))
 423     return true;
 424
 425   // Set correct read and write permissions after temporary file is moved
 426   // to final destination path.
 427   if (sys::Path(archPath).makeReadableOnDisk(ErrMsg))
 428     return true;
 429   if (sys::Path(archPath).makeWriteableOnDisk(ErrMsg))
 430     return true;
 431
 432   return false;
 433 }