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