lib/Bytecode/Archive/ArchiveReader.cpp

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