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