tools/llvm-ar/ArchiveReader.cpp

   1 //===-- ArchiveReader.cpp - Read LLVM archive files -------------*- C++ -*-===//
   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 standard unix archive files (.a) containing LLVM bitcode.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "Archive.h"
  15 #include "ArchiveInternals.h"
  16 #include "llvm/ADT/OwningPtr.h"
  17 #include "llvm/ADT/SmallPtrSet.h"
  18 #include "llvm/Bitcode/ReaderWriter.h"
  19 #include "llvm/IR/Module.h"
  20 #include "llvm/Support/FileSystem.h"
  21 #include "llvm/Support/MemoryBuffer.h"
  22 #include <cstdio>
  23 #include <cstdlib>
  24 using namespace llvm;
  25
  26 /// Read a variable-bit-rate encoded unsigned integer
  27 static inline unsigned readInteger(const char*&At, const char*End) {
  28   unsigned Shift = 0;
  29   unsigned Result = 0;
  30
  31   do {
  32     if (At == End)
  33       return Result;
  34     Result |= (unsigned)((*At++) & 0x7F) << Shift;
  35     Shift += 7;
  36   } while (At[-1] & 0x80);
  37   return Result;
  38 }
  39
  40 // This member parses an ArchiveMemberHeader that is presumed to be pointed to
  41 // by At. The At pointer is updated to the byte just after the header, which
  42 // can be variable in size.
  43 ArchiveMember*
  44 Archive::parseMemberHeader(const char*& At, const char* End, std::string* error)
  45 {
  46   if (At + sizeof(ArchiveMemberHeader) >= End) {
  47     if (error)
  48       *error = "Unexpected end of file";
  49     return 0;
  50   }
  51
  52   // Cast archive member header
  53   const ArchiveMemberHeader* Hdr = (const ArchiveMemberHeader*)At;
  54   At += sizeof(ArchiveMemberHeader);
  55
  56   int flags = 0;
  57   int MemberSize = atoi(Hdr->size);
  58   assert(MemberSize >= 0);
  59
  60   // Check the size of the member for sanity
  61   if (At + MemberSize > End) {
  62     if (error)
  63       *error = "invalid member length in archive file";
  64     return 0;
  65   }
  66
  67   // Check the member signature
  68   if (!Hdr->checkSignature()) {
  69     if (error)
  70       *error = "invalid file member signature";
  71     return 0;
  72   }
  73
  74   // Convert and check the member name
  75   // The empty name ( '/' and 15 blanks) is for a foreign (non-LLVM) symbol
  76   // table. The special name "//" and 14 blanks is for a string table, used
  77   // for long file names. This library doesn't generate either of those but
  78   // it will accept them. If the name starts with #1/ and the remainder is
  79   // digits, then those digits specify the length of the name that is
  80   // stored immediately following the header. Anything else is a regular, short
  81   // filename that is terminated with a '/' and blanks.
  82
  83   std::string pathname;
  84   switch (Hdr->name[0]) {
  85     case '#':
  86       if (Hdr->name[1] == '1' && Hdr->name[2] == '/') {
  87         if (isdigit(Hdr->name[3])) {
  88           unsigned len = atoi(&Hdr->name[3]);
  89           const char *nulp = (const char *)memchr(At, '\0', len);
  90           pathname.assign(At, nulp != 0 ? (uintptr_t)(nulp - At) : len);
  91           At += len;
  92           MemberSize -= len;
  93           flags |= ArchiveMember::HasLongFilenameFlag;
  94         } else {
  95           if (error)
  96             *error = "invalid long filename";
  97           return 0;
  98         }
  99       }
 100       break;
 101     case '/':
 102       if (Hdr->name[1]== '/') {
 103         if (0 == memcmp(Hdr->name, ARFILE_STRTAB_NAME, 16)) {
 104           pathname.assign(ARFILE_STRTAB_NAME);
 105           flags |= ArchiveMember::StringTableFlag;
 106         } else {
 107           if (error)
 108             *error = "invalid string table name";
 109           return 0;
 110         }
 111       } else if (Hdr->name[1] == ' ') {
 112         if (0 == memcmp(Hdr->name, ARFILE_SVR4_SYMTAB_NAME, 16)) {
 113           pathname.assign(ARFILE_SVR4_SYMTAB_NAME);
 114           flags |= ArchiveMember::SVR4SymbolTableFlag;
 115         } else {
 116           if (error)
 117             *error = "invalid SVR4 symbol table name";
 118           return 0;
 119         }
 120       } else if (isdigit(Hdr->name[1])) {
 121         unsigned index = atoi(&Hdr->name[1]);
 122         if (index < strtab.length()) {
 123           const char* namep = strtab.c_str() + index;
 124           const char* endp = strtab.c_str() + strtab.length();
 125           const char* p = namep;
 126           const char* last_p = p;
 127           while (p < endp) {
 128             if (*p == '\n' && *last_p == '/') {
 129               pathname.assign(namep, last_p - namep);
 130               flags |= ArchiveMember::HasLongFilenameFlag;
 131               break;
 132             }
 133             last_p = p;
 134             p++;
 135           }
 136           if (p >= endp) {
 137             if (error)
 138               *error = "missing name terminator in string table";
 139             return 0;
 140           }
 141         } else {
 142           if (error)
 143             *error = "name index beyond string table";
 144           return 0;
 145         }
 146       }
 147       break;
 148     case '_':
 149       if (Hdr->name[1] == '_' &&
 150           (0 == memcmp(Hdr->name, ARFILE_BSD4_SYMTAB_NAME, 16))) {
 151         pathname.assign(ARFILE_BSD4_SYMTAB_NAME);
 152         flags |= ArchiveMember::BSD4SymbolTableFlag;
 153         break;
 154       }
 155       /* FALL THROUGH */
 156
 157     default:
 158       const char* slash = (const char*) memchr(Hdr->name, '/', 16);
 159       if (slash == 0)
 160         slash = Hdr->name + 16;
 161       pathname.assign(Hdr->name, slash - Hdr->name);
 162       break;
 163   }
 164
 165   // Determine if this is a bitcode file
 166   if (sys::fs::identify_magic(StringRef(At, 4)) ==
 167       sys::fs::file_magic::bitcode)
 168     flags |= ArchiveMember::BitcodeFlag;
 169   else
 170     flags &= ~ArchiveMember::BitcodeFlag;
 171
 172   // Instantiate the ArchiveMember to be filled
 173   ArchiveMember* member = new ArchiveMember(this);
 174
 175   // Fill in fields of the ArchiveMember
 176   member->parent = this;
 177   member->path = pathname;
 178   member->info.fileSize = MemberSize;
 179   member->info.modTime.fromEpochTime(atoi(Hdr->date));
 180   unsigned int mode;
 181   sscanf(Hdr->mode, "%o", &mode);
 182   member->info.mode = mode;
 183   member->info.user = atoi(Hdr->uid);
 184   member->info.group = atoi(Hdr->gid);
 185   member->flags = flags;
 186   member->data = At;
 187
 188   return member;
 189 }
 190
 191 bool
 192 Archive::checkSignature(std::string* error) {
 193   // Check the magic string at file's header
 194   if (mapfile->getBufferSize() < 8 || memcmp(base, ARFILE_MAGIC, 8)) {
 195     if (error)
 196       *error = "invalid signature for an archive file";
 197     return false;
 198   }
 199   return true;
 200 }
 201
 202 // This function loads the entire archive and fully populates its ilist with
 203 // the members of the archive file. This is typically used in preparation for
 204 // editing the contents of the archive.
 205 bool
 206 Archive::loadArchive(std::string* error) {
 207
 208   // Set up parsing
 209   members.clear();
 210   symTab.clear();
 211   const char *At = base;
 212   const char *End = mapfile->getBufferEnd();
 213
 214   if (!checkSignature(error))
 215     return false;
 216
 217   At += 8;  // Skip the magic string.
 218
 219   bool foundFirstFile = false;
 220   while (At < End) {
 221     // parse the member header
 222     const char* Save = At;
 223     ArchiveMember* mbr = parseMemberHeader(At, End, error);
 224     if (!mbr)
 225       return false;
 226
 227     // check if this is the foreign symbol table
 228     if (mbr->isSVR4SymbolTable() || mbr->isBSD4SymbolTable()) {
 229       // We just save this but don't do anything special
 230       // with it. It doesn't count as the "first file".
 231       if (foreignST) {
 232         // What? Multiple foreign symbol tables? Just chuck it
 233         // and retain the last one found.
 234         delete foreignST;
 235       }
 236       foreignST = mbr;
 237       At += mbr->getSize();
 238       if ((intptr_t(At) & 1) == 1)
 239         At++;
 240     } else if (mbr->isStringTable()) {
 241       // Simply suck the entire string table into a string
 242       // variable. This will be used to get the names of the
 243       // members that use the "/ddd" format for their names
 244       // (SVR4 style long names).
 245       strtab.assign(At, mbr->getSize());
 246       At += mbr->getSize();
 247       if ((intptr_t(At) & 1) == 1)
 248         At++;
 249       delete mbr;
 250     } else {
 251       // This is just a regular file. If its the first one, save its offset.
 252       // Otherwise just push it on the list and move on to the next file.
 253       if (!foundFirstFile) {
 254         firstFileOffset = Save - base;
 255         foundFirstFile = true;
 256       }
 257       members.push_back(mbr);
 258       At += mbr->getSize();
 259       if ((intptr_t(At) & 1) == 1)
 260         At++;
 261     }
 262   }
 263   return true;
 264 }
 265
 266 // Open and completely load the archive file.
 267 Archive*
 268 Archive::OpenAndLoad(StringRef File, LLVMContext& C,
 269                      std::string* ErrorMessage) {
 270   OwningPtr<Archive> result(new Archive(File, C));
 271   if (result->mapToMemory(ErrorMessage))
 272     return NULL;
 273   if (!result->loadArchive(ErrorMessage))
 274     return NULL;
 275   return result.take();
 276 }
 277
 278 // Get all the bitcode modules from the archive
 279 bool
 280 Archive::getAllModules(std::vector<Module*>& Modules,
 281                        std::string* ErrMessage) {
 282
 283   for (iterator I=begin(), E=end(); I != E; ++I) {
 284     if (I->isBitcode()) {
 285       std::string FullMemberName = archPath + "(" + I->getPath().str() + ")";
 286       MemoryBuffer *Buffer =
 287         MemoryBuffer::getMemBufferCopy(StringRef(I->getData(), I->getSize()),
 288                                        FullMemberName.c_str());
 289
 290       Module *M = ParseBitcodeFile(Buffer, Context, ErrMessage);
 291       delete Buffer;
 292       if (!M)
 293         return true;
 294
 295       Modules.push_back(M);
 296     }
 297   }
 298   return false;
 299 }
 300
 301 // Load just the symbol table from the archive file
 302 bool
 303 Archive::loadSymbolTable(std::string* ErrorMsg) {
 304
 305   // Set up parsing
 306   members.clear();
 307   symTab.clear();
 308   const char *At = base;
 309   const char *End = mapfile->getBufferEnd();
 310
 311   // Make sure we're dealing with an archive
 312   if (!checkSignature(ErrorMsg))
 313     return false;
 314
 315   At += 8; // Skip signature
 316
 317   // Parse the first file member header
 318   const char* FirstFile = At;
 319   ArchiveMember* mbr = parseMemberHeader(At, End, ErrorMsg);
 320   if (!mbr)
 321     return false;
 322
 323   if (mbr->isSVR4SymbolTable() || mbr->isBSD4SymbolTable()) {
 324     // Skip the foreign symbol table, we don't do anything with it
 325     At += mbr->getSize();
 326     if ((intptr_t(At) & 1) == 1)
 327       At++;
 328     delete mbr;
 329
 330     // Read the next one
 331     FirstFile = At;
 332     mbr = parseMemberHeader(At, End, ErrorMsg);
 333     if (!mbr) {
 334       delete mbr;
 335       return false;
 336     }
 337   }
 338
 339   if (mbr->isStringTable()) {
 340     // Process the string table entry
 341     strtab.assign((const char*)mbr->getData(), mbr->getSize());
 342     At += mbr->getSize();
 343     if ((intptr_t(At) & 1) == 1)
 344       At++;
 345     delete mbr;
 346     // Get the next one
 347     FirstFile = At;
 348     mbr = parseMemberHeader(At, End, ErrorMsg);
 349     if (!mbr) {
 350       delete mbr;
 351       return false;
 352     }
 353   }
 354
 355   // There's no symbol table in the file. We have to rebuild it from scratch
 356   // because the intent of this method is to get the symbol table loaded so
 357   // it can be searched efficiently.
 358   // Add the member to the members list
 359   members.push_back(mbr);
 360
 361   firstFileOffset = FirstFile - base;
 362   return true;
 363 }
 364
 365 // Look up one symbol in the symbol table and return the module that defines
 366 // that symbol.
 367 Module*
 368 Archive::findModuleDefiningSymbol(const std::string& symbol,
 369                                   std::string* ErrMsg) {
 370   SymTabType::iterator SI = symTab.find(symbol);
 371   if (SI == symTab.end())
 372     return 0;
 373
 374   // The symbol table was previously constructed assuming that the members were
 375   // written without the symbol table header. Because VBR encoding is used, the
 376   // values could not be adjusted to account for the offset of the symbol table
 377   // because that could affect the size of the symbol table due to VBR encoding.
 378   // We now have to account for this by adjusting the offset by the size of the
 379   // symbol table and its header.
 380   unsigned fileOffset =
 381     SI->second +                // offset in symbol-table-less file
 382     firstFileOffset;            // add offset to first "real" file in archive
 383
 384   // See if the module is already loaded
 385   ModuleMap::iterator MI = modules.find(fileOffset);
 386   if (MI != modules.end())
 387     return MI->second.first;
 388
 389   // Module hasn't been loaded yet, we need to load it
 390   const char* modptr = base + fileOffset;
 391   ArchiveMember* mbr = parseMemberHeader(modptr, mapfile->getBufferEnd(),
 392                                          ErrMsg);
 393   if (!mbr)
 394     return 0;
 395
 396   // Now, load the bitcode module to get the Module.
 397   std::string FullMemberName = archPath + "(" + mbr->getPath().str() + ")";
 398   MemoryBuffer *Buffer =
 399     MemoryBuffer::getMemBufferCopy(StringRef(mbr->getData(), mbr->getSize()),
 400                                    FullMemberName.c_str());
 401
 402   Module *m = getLazyBitcodeModule(Buffer, Context, ErrMsg);
 403   if (!m)
 404     return 0;
 405
 406   modules.insert(std::make_pair(fileOffset, std::make_pair(m, mbr)));
 407
 408   return m;
 409 }
 410
 411 // Look up multiple symbols in the symbol table and return a set of
 412 // Modules that define those symbols.
 413 bool
 414 Archive::findModulesDefiningSymbols(std::set<std::string>& symbols,
 415                                     SmallVectorImpl<Module*>& result,
 416                                     std::string* error) {
 417   if (!mapfile || !base) {
 418     if (error)
 419       *error = "Empty archive invalid for finding modules defining symbols";
 420     return false;
 421   }
 422
 423   if (symTab.empty()) {
 424     // We don't have a symbol table, so we must build it now but lets also
 425     // make sure that we populate the modules table as we do this to ensure
 426     // that we don't load them twice when findModuleDefiningSymbol is called
 427     // below.
 428
 429     // Get a pointer to the first file
 430     const char* At  = base + firstFileOffset;
 431     const char* End = mapfile->getBufferEnd();
 432
 433     while ( At < End) {
 434       // Compute the offset to be put in the symbol table
 435       unsigned offset = At - base - firstFileOffset;
 436
 437       // Parse the file's header
 438       ArchiveMember* mbr = parseMemberHeader(At, End, error);
 439       if (!mbr)
 440         return false;
 441
 442       // If it contains symbols
 443       if (mbr->isBitcode()) {
 444         // Get the symbols
 445         std::vector<std::string> symbols;
 446         std::string FullMemberName =
 447             archPath + "(" + mbr->getPath().str() + ")";
 448         Module* M =
 449           GetBitcodeSymbols(At, mbr->getSize(), FullMemberName, Context,
 450                             symbols, error);
 451
 452         if (M) {
 453           // Insert the module's symbols into the symbol table
 454           for (std::vector<std::string>::iterator I = symbols.begin(),
 455                E=symbols.end(); I != E; ++I ) {
 456             symTab.insert(std::make_pair(*I, offset));
 457           }
 458           // Insert the Module and the ArchiveMember into the table of
 459           // modules.
 460           modules.insert(std::make_pair(offset, std::make_pair(M, mbr)));
 461         } else {
 462           if (error)
 463             *error = "Can't parse bitcode member: " +
 464               mbr->getPath().str() + ": " + *error;
 465           delete mbr;
 466           return false;
 467         }
 468       }
 469
 470       // Go to the next file location
 471       At += mbr->getSize();
 472       if ((intptr_t(At) & 1) == 1)
 473         At++;
 474     }
 475   }
 476
 477   // At this point we have a valid symbol table (one way or another) so we
 478   // just use it to quickly find the symbols requested.
 479
 480   SmallPtrSet<Module*, 16> Added;
 481   for (std::set<std::string>::iterator I=symbols.begin(),
 482          Next = I,
 483          E=symbols.end(); I != E; I = Next) {
 484     // Increment Next before we invalidate it.
 485     ++Next;
 486
 487     // See if this symbol exists
 488     Module* m = findModuleDefiningSymbol(*I,error);
 489     if (!m)
 490       continue;
 491     bool NewMember = Added.insert(m);
 492     if (!NewMember)
 493       continue;
 494
 495     // The symbol exists, insert the Module into our result.
 496     result.push_back(m);
 497
 498     // Remove the symbol now that its been resolved.
 499     symbols.erase(I);
 500   }
 501   return true;
 502 }
 503
 504 bool Archive::isBitcodeArchive() {
 505   // Make sure the symTab has been loaded. In most cases this should have been
 506   // done when the archive was constructed, but still,  this is just in case.
 507   if (symTab.empty())
 508     if (!loadSymbolTable(0))
 509       return false;
 510
 511   // Now that we know it's been loaded, return true
 512   // if it has a size
 513   if (symTab.size()) return true;
 514
 515   // We still can't be sure it isn't a bitcode archive
 516   if (!loadArchive(0))
 517     return false;
 518
 519   std::vector<Module *> Modules;
 520   std::string ErrorMessage;
 521
 522   // Scan the archive, trying to load a bitcode member.  We only load one to
 523   // see if this works.
 524   for (iterator I = begin(), E = end(); I != E; ++I) {
 525     if (!I->isBitcode())
 526       continue;
 527
 528     std::string FullMemberName = archPath + "(" + I->getPath().str() + ")";
 529
 530     MemoryBuffer *Buffer =
 531       MemoryBuffer::getMemBufferCopy(StringRef(I->getData(), I->getSize()),
 532                                      FullMemberName.c_str());
 533     Module *M = ParseBitcodeFile(Buffer, Context);
 534     delete Buffer;
 535     if (!M)
 536       return false;  // Couldn't parse bitcode, not a bitcode archive.
 537     delete M;
 538     return true;
 539   }
 540
 541   return false;
 542 }