X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=lib%2FArchive%2FArchiveReader.cpp;h=efe1180762f33da3c00dd55eb85a5722ddffb135;hb=0b8c9a80f20772c3793201ab5b251d3520b9cea3;hp=f238f59882eb42a715321e0c55ce61c12e428092;hpb=ffb4d62720f491614801668acda2f89a4f878d98;p=oota-llvm.git diff --git a/lib/Archive/ArchiveReader.cpp b/lib/Archive/ArchiveReader.cpp index f238f59882e..efe1180762f 100644 --- a/lib/Archive/ArchiveReader.cpp +++ b/lib/Archive/ArchiveReader.cpp @@ -2,29 +2,34 @@ // // The LLVM Compiler Infrastructure // -// This file was developed by Reid Spencer and is distributed under the -// University of Illinois Open Source License. See LICENSE.TXT for details. +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // -// Builds up standard unix archive files (.a) containing LLVM bytecode. +// Builds up standard unix archive files (.a) containing LLVM bitcode. // //===----------------------------------------------------------------------===// +#include "llvm/Bitcode/Archive.h" #include "ArchiveInternals.h" -#include "llvm/Bytecode/Reader.h" +#include "llvm/ADT/SmallPtrSet.h" +#include "llvm/Bitcode/ReaderWriter.h" +#include "llvm/IR/Module.h" +#include "llvm/Support/MemoryBuffer.h" +#include +#include #include - using namespace llvm; /// Read a variable-bit-rate encoded unsigned integer -inline unsigned readInteger(const char*&At, const char*End) { +static inline unsigned readInteger(const char*&At, const char*End) { unsigned Shift = 0; unsigned Result = 0; do { if (At == End) - throw std::string("Ran out of data reading vbr_uint!"); + return Result; Result |= (unsigned)((*At++) & 0x7F) << Shift; Shift += 7; } while (At[-1] & 0x80); @@ -32,52 +37,69 @@ inline unsigned readInteger(const char*&At, const char*End) { } // Completely parse the Archive's symbol table and populate symTab member var. -void -Archive::parseSymbolTable(const void* data, unsigned size) { +bool +Archive::parseSymbolTable(const void* data, unsigned size, std::string* error) { const char* At = (const char*) data; const char* End = At + size; while (At < End) { unsigned offset = readInteger(At, End); + if (At == End) { + if (error) + *error = "Ran out of data reading vbr_uint for symtab offset!"; + return false; + } unsigned length = readInteger(At, End); - if (At + length > End) - throw std::string("malformed symbol table"); + if (At == End) { + if (error) + *error = "Ran out of data reading vbr_uint for symtab length!"; + return false; + } + if (At + length > End) { + if (error) + *error = "Malformed symbol table: length not consistent with size"; + return false; + } // we don't care if it can't be inserted (duplicate entry) symTab.insert(std::make_pair(std::string(At, length), offset)); At += length; } symTabSize = size; + return true; } // This member parses an ArchiveMemberHeader that is presumed to be pointed to // by At. The At pointer is updated to the byte just after the header, which // can be variable in size. ArchiveMember* -Archive::parseMemberHeader(const char*& At, const char* End) { - assert(At + sizeof(ArchiveMemberHeader) < End && "Not enough data"); +Archive::parseMemberHeader(const char*& At, const char* End, std::string* error) +{ + if (At + sizeof(ArchiveMemberHeader) >= End) { + if (error) + *error = "Unexpected end of file"; + return 0; + } // Cast archive member header - ArchiveMemberHeader* Hdr = (ArchiveMemberHeader*)At; + const ArchiveMemberHeader* Hdr = (const ArchiveMemberHeader*)At; At += sizeof(ArchiveMemberHeader); - // Instantiate the ArchiveMember to be filled - ArchiveMember* member = new ArchiveMember(this); - - // Extract the size and determine if the file is - // compressed or not (negative length). int flags = 0; int MemberSize = atoi(Hdr->size); - if (MemberSize < 0) { - flags |= ArchiveMember::CompressedFlag; - MemberSize = -MemberSize; - } + assert(MemberSize >= 0); // Check the size of the member for sanity - if (At + MemberSize > End) - throw std::string("invalid member length in archive file"); + if (At + MemberSize > End) { + if (error) + *error = "invalid member length in archive file"; + return 0; + } // Check the member signature - if (!Hdr->checkSignature()) - throw std::string("invalid file member signature"); + if (!Hdr->checkSignature()) { + if (error) + *error = "invalid file member signature"; + return 0; + } // Convert and check the member name // The empty name ( '/' and 15 blanks) is for a foreign (non-LLVM) symbol @@ -86,7 +108,7 @@ Archive::parseMemberHeader(const char*& At, const char* End) { // it will accept them. If the name starts with #1/ and the remainder is // digits, then those digits specify the length of the name that is // stored immediately following the header. The special name - // __LLVM_SYM_TAB__ identifies the symbol table for LLVM bytecode. + // __LLVM_SYM_TAB__ identifies the symbol table for LLVM bitcode. // Anything else is a regular, short filename that is terminated with // a '/' and blanks. @@ -96,12 +118,16 @@ Archive::parseMemberHeader(const char*& At, const char* End) { if (Hdr->name[1] == '1' && Hdr->name[2] == '/') { if (isdigit(Hdr->name[3])) { unsigned len = atoi(&Hdr->name[3]); - pathname.assign(At, len); + const char *nulp = (const char *)memchr(At, '\0', len); + pathname.assign(At, nulp != 0 ? (uintptr_t)(nulp - At) : len); At += len; MemberSize -= len; flags |= ArchiveMember::HasLongFilenameFlag; - } else - throw std::string("invalid long filename"); + } else { + if (error) + *error = "invalid long filename"; + return 0; + } } else if (Hdr->name[1] == '_' && (0 == memcmp(Hdr->name, ARFILE_LLVM_SYMTAB_NAME, 16))) { // The member is using a long file name (>15 chars) format. @@ -120,14 +146,18 @@ Archive::parseMemberHeader(const char*& At, const char* End) { pathname.assign(ARFILE_STRTAB_NAME); flags |= ArchiveMember::StringTableFlag; } else { - throw std::string("invalid string table name"); + if (error) + *error = "invalid string table name"; + return 0; } } else if (Hdr->name[1] == ' ') { if (0 == memcmp(Hdr->name, ARFILE_SVR4_SYMTAB_NAME, 16)) { pathname.assign(ARFILE_SVR4_SYMTAB_NAME); flags |= ArchiveMember::SVR4SymbolTableFlag; } else { - throw std::string("invalid SVR4 symbol table name"); + if (error) + *error = "invalid SVR4 symbol table name"; + return 0; } } else if (isdigit(Hdr->name[1])) { unsigned index = atoi(&Hdr->name[1]); @@ -145,10 +175,15 @@ Archive::parseMemberHeader(const char*& At, const char* End) { last_p = p; p++; } - if (p >= endp) - throw std::string("missing name termiantor in string table"); + if (p >= endp) { + if (error) + *error = "missing name termiantor in string table"; + return 0; + } } else { - throw std::string("name index beyond string table"); + if (error) + *error = "name index beyond string table"; + return 0; } } break; @@ -162,31 +197,27 @@ Archive::parseMemberHeader(const char*& At, const char* End) { /* FALL THROUGH */ default: - char* slash = (char*) memchr(Hdr->name, '/', 16); + const char* slash = (const char*) memchr(Hdr->name, '/', 16); if (slash == 0) slash = Hdr->name + 16; pathname.assign(Hdr->name, slash - Hdr->name); break; } - // Determine if this is a bytecode file + // Determine if this is a bitcode file switch (sys::IdentifyFileType(At, 4)) { - case sys::BytecodeFileType: - flags |= ArchiveMember::BytecodeFlag; - break; - case sys::CompressedBytecodeFileType: - flags |= ArchiveMember::CompressedBytecodeFlag; - flags &= ~ArchiveMember::CompressedFlag; + case sys::Bitcode_FileType: + flags |= ArchiveMember::BitcodeFlag; break; default: - flags &= ~(ArchiveMember::BytecodeFlag| - ArchiveMember::CompressedBytecodeFlag); + flags &= ~ArchiveMember::BitcodeFlag; break; } + // Instantiate the ArchiveMember to be filled + ArchiveMember* member = new ArchiveMember(this); + // Fill in fields of the ArchiveMember - member->next = 0; - member->prev = 0; member->parent = this; member->path.set(pathname); member->info.fileSize = MemberSize; @@ -202,26 +233,32 @@ Archive::parseMemberHeader(const char*& At, const char* End) { return member; } -void -Archive::checkSignature() { +bool +Archive::checkSignature(std::string* error) { // Check the magic string at file's header - if (mapfile->size() < 8 || memcmp(base, ARFILE_MAGIC, 8)) - throw std::string("invalid signature for an archive file"); + if (mapfile->getBufferSize() < 8 || memcmp(base, ARFILE_MAGIC, 8)) { + if (error) + *error = "invalid signature for an archive file"; + return false; + } + return true; } // This function loads the entire archive and fully populates its ilist with // the members of the archive file. This is typically used in preparation for // editing the contents of the archive. -void -Archive::loadArchive() { +bool +Archive::loadArchive(std::string* error) { // Set up parsing members.clear(); symTab.clear(); const char *At = base; - const char *End = base + mapfile->size(); + const char *End = mapfile->getBufferEnd(); + + if (!checkSignature(error)) + return false; - checkSignature(); At += 8; // Skip the magic string. bool seenSymbolTable = false; @@ -229,7 +266,9 @@ Archive::loadArchive() { while (At < End) { // parse the member header const char* Save = At; - ArchiveMember* mbr = parseMemberHeader(At, End); + ArchiveMember* mbr = parseMemberHeader(At, End, error); + if (!mbr) + return false; // check if this is the foreign symbol table if (mbr->isSVR4SymbolTable() || mbr->isBSD4SymbolTable()) { @@ -257,9 +296,13 @@ Archive::loadArchive() { } else if (mbr->isLLVMSymbolTable()) { // This is the LLVM symbol table for the archive. If we've seen it // already, its an error. Otherwise, parse the symbol table and move on. - if (seenSymbolTable) - throw std::string("invalid archive: multiple symbol tables"); - parseSymbolTable(mbr->getData(), mbr->getSize()); + if (seenSymbolTable) { + if (error) + *error = "invalid archive: multiple symbol tables"; + return false; + } + if (!parseSymbolTable(mbr->getData(), mbr->getSize(), error)) + return false; seenSymbolTable = true; At += mbr->getSize(); if ((intptr_t(At) & 1) == 1) @@ -278,33 +321,36 @@ Archive::loadArchive() { At++; } } + return true; } // Open and completely load the archive file. Archive* -Archive::OpenAndLoad(const sys::Path& file, std::string* ErrorMessage) { - try { - std::auto_ptr result ( new Archive(file, true)); - result->loadArchive(); - return result.release(); - } catch (const std::string& msg) { - if (ErrorMessage) { - *ErrorMessage = msg; - } +Archive::OpenAndLoad(const sys::Path& file, LLVMContext& C, + std::string* ErrorMessage) { + std::auto_ptr result ( new Archive(file, C)); + if (result->mapToMemory(ErrorMessage)) return 0; - } + if (!result->loadArchive(ErrorMessage)) + return 0; + return result.release(); } -// Get all the bytecode modules from the archive +// Get all the bitcode modules from the archive bool -Archive::getAllModules(std::vector& Modules, std::string* ErrMessage) { +Archive::getAllModules(std::vector& Modules, + std::string* ErrMessage) { for (iterator I=begin(), E=end(); I != E; ++I) { - if (I->isBytecode() || I->isCompressedBytecode()) { - std::string FullMemberName = archPath.toString() + - "(" + I->getPath().toString() + ")"; - Module* M = ParseBytecodeBuffer((const unsigned char*)I->getData(), - I->getSize(), FullMemberName, ErrMessage); + if (I->isBitcode()) { + std::string FullMemberName = archPath.str() + + "(" + I->getPath().str() + ")"; + MemoryBuffer *Buffer = + MemoryBuffer::getMemBufferCopy(StringRef(I->getData(), I->getSize()), + FullMemberName.c_str()); + + Module *M = ParseBitcodeFile(Buffer, Context, ErrMessage); + delete Buffer; if (!M) return true; @@ -315,23 +361,26 @@ Archive::getAllModules(std::vector& Modules, std::string* ErrMessage) { } // Load just the symbol table from the archive file -void -Archive::loadSymbolTable() { +bool +Archive::loadSymbolTable(std::string* ErrorMsg) { // Set up parsing members.clear(); symTab.clear(); const char *At = base; - const char *End = base + mapfile->size(); + const char *End = mapfile->getBufferEnd(); // Make sure we're dealing with an archive - checkSignature(); + if (!checkSignature(ErrorMsg)) + return false; At += 8; // Skip signature // Parse the first file member header const char* FirstFile = At; - ArchiveMember* mbr = parseMemberHeader(At, End); + ArchiveMember* mbr = parseMemberHeader(At, End, ErrorMsg); + if (!mbr) + return false; if (mbr->isSVR4SymbolTable() || mbr->isBSD4SymbolTable()) { // Skip the foreign symbol table, we don't do anything with it @@ -342,7 +391,11 @@ Archive::loadSymbolTable() { // Read the next one FirstFile = At; - mbr = parseMemberHeader(At, End); + mbr = parseMemberHeader(At, End, ErrorMsg); + if (!mbr) { + delete mbr; + return false; + } } if (mbr->isStringTable()) { @@ -354,12 +407,20 @@ Archive::loadSymbolTable() { delete mbr; // Get the next one FirstFile = At; - mbr = parseMemberHeader(At, End); + mbr = parseMemberHeader(At, End, ErrorMsg); + if (!mbr) { + delete mbr; + return false; + } } // See if its the symbol table if (mbr->isLLVMSymbolTable()) { - parseSymbolTable(mbr->getData(), mbr->getSize()); + if (!parseSymbolTable(mbr->getData(), mbr->getSize(), ErrorMsg)) { + delete mbr; + return false; + } + At += mbr->getSize(); if ((intptr_t(At) & 1) == 1) At++; @@ -375,27 +436,26 @@ Archive::loadSymbolTable() { } firstFileOffset = FirstFile - base; + return true; } // Open the archive and load just the symbol tables -Archive* -Archive::OpenAndLoadSymbols(const sys::Path& file, std::string* ErrorMessage) { - try { - std::auto_ptr result ( new Archive(file, true) ); - result->loadSymbolTable(); - return result.release(); - } catch (const std::string& msg) { - if (ErrorMessage) { - *ErrorMessage = msg; - } +Archive* Archive::OpenAndLoadSymbols(const sys::Path& file, + LLVMContext& C, + std::string* ErrorMessage) { + std::auto_ptr result ( new Archive(file, C) ); + if (result->mapToMemory(ErrorMessage)) return 0; - } + if (!result->loadSymbolTable(ErrorMessage)) + return 0; + return result.release(); } -// Look up one symbol in the symbol table and return a ModuleProvider for the -// module that defines that symbol. -ModuleProvider* -Archive::findModuleDefiningSymbol(const std::string& symbol) { +// Look up one symbol in the symbol table and return the module that defines +// that symbol. +Module* +Archive::findModuleDefiningSymbol(const std::string& symbol, + std::string* ErrMsg) { SymTabType::iterator SI = symTab.find(symbol); if (SI == symTab.end()) return 0; @@ -417,27 +477,39 @@ Archive::findModuleDefiningSymbol(const std::string& symbol) { // Module hasn't been loaded yet, we need to load it const char* modptr = base + fileOffset; - ArchiveMember* mbr = parseMemberHeader(modptr, base + mapfile->size()); + ArchiveMember* mbr = parseMemberHeader(modptr, mapfile->getBufferEnd(), + ErrMsg); + if (!mbr) + return 0; - // Now, load the bytecode module to get the ModuleProvider - std::string FullMemberName = archPath.toString() + "(" + - mbr->getPath().toString() + ")"; - ModuleProvider* mp = getBytecodeBufferModuleProvider( - (const unsigned char*) mbr->getData(), mbr->getSize(), - FullMemberName, 0); + // Now, load the bitcode module to get the Module. + std::string FullMemberName = archPath.str() + "(" + + mbr->getPath().str() + ")"; + MemoryBuffer *Buffer = + MemoryBuffer::getMemBufferCopy(StringRef(mbr->getData(), mbr->getSize()), + FullMemberName.c_str()); + + Module *m = getLazyBitcodeModule(Buffer, Context, ErrMsg); + if (!m) + return 0; - modules.insert(std::make_pair(fileOffset, std::make_pair(mp, mbr))); + modules.insert(std::make_pair(fileOffset, std::make_pair(m, mbr))); - return mp; + return m; } // Look up multiple symbols in the symbol table and return a set of -// ModuleProviders that define those symbols. -void +// Modules that define those symbols. +bool Archive::findModulesDefiningSymbols(std::set& symbols, - std::set& result) -{ - assert(mapfile && base && "Can't findModulesDefiningSymbols on new archive"); + SmallVectorImpl& result, + std::string* error) { + if (!mapfile || !base) { + if (error) + *error = "Empty archive invalid for finding modules defining symbols"; + return false; + } + if (symTab.empty()) { // We don't have a symbol table, so we must build it now but lets also // make sure that we populate the modules table as we do this to ensure @@ -445,37 +517,43 @@ Archive::findModulesDefiningSymbols(std::set& symbols, // below. // Get a pointer to the first file - const char* At = ((const char*)base) + firstFileOffset; - const char* End = ((const char*)base) + mapfile->size(); + const char* At = base + firstFileOffset; + const char* End = mapfile->getBufferEnd(); while ( At < End) { // Compute the offset to be put in the symbol table unsigned offset = At - base - firstFileOffset; // Parse the file's header - ArchiveMember* mbr = parseMemberHeader(At, End); + ArchiveMember* mbr = parseMemberHeader(At, End, error); + if (!mbr) + return false; // If it contains symbols - if (mbr->isBytecode() || mbr->isCompressedBytecode()) { + if (mbr->isBitcode()) { // Get the symbols std::vector symbols; - std::string FullMemberName = archPath.toString() + "(" + - mbr->getPath().toString() + ")"; - ModuleProvider* MP = GetBytecodeSymbols((const unsigned char*)At, - mbr->getSize(), FullMemberName, symbols); + std::string FullMemberName = archPath.str() + "(" + + mbr->getPath().str() + ")"; + Module* M = + GetBitcodeSymbols(At, mbr->getSize(), FullMemberName, Context, + symbols, error); - if (MP) { + if (M) { // Insert the module's symbols into the symbol table for (std::vector::iterator I = symbols.begin(), E=symbols.end(); I != E; ++I ) { symTab.insert(std::make_pair(*I, offset)); } - // Insert the ModuleProvider and the ArchiveMember into the table of + // Insert the Module and the ArchiveMember into the table of // modules. - modules.insert(std::make_pair(offset, std::make_pair(MP, mbr))); + modules.insert(std::make_pair(offset, std::make_pair(M, mbr))); } else { - throw std::string("Can't parse bytecode member: ") + - mbr->getPath().toString(); + if (error) + *error = "Can't parse bitcode member: " + + mbr->getPath().str() + ": " + *error; + delete mbr; + return false; } } @@ -489,52 +567,64 @@ Archive::findModulesDefiningSymbols(std::set& symbols, // At this point we have a valid symbol table (one way or another) so we // just use it to quickly find the symbols requested. + SmallPtrSet Added; for (std::set::iterator I=symbols.begin(), - E=symbols.end(); I != E;) { + Next = I, + E=symbols.end(); I != E; I = Next) { + // Increment Next before we invalidate it. + ++Next; + // See if this symbol exists - ModuleProvider* mp = findModuleDefiningSymbol(*I); - if (mp) { - // The symbol exists, insert the ModuleProvider into our result, - // duplicates wil be ignored - result.insert(mp); - - // Remove the symbol now that its been resolved, being careful to - // post-increment the iterator. - symbols.erase(I++); - } else { - ++I; - } + Module* m = findModuleDefiningSymbol(*I,error); + if (!m) + continue; + bool NewMember = Added.insert(m); + if (!NewMember) + continue; + + // The symbol exists, insert the Module into our result. + result.push_back(m); + + // Remove the symbol now that its been resolved. + symbols.erase(I); } + return true; } -bool Archive::isBytecodeArchive() { +bool Archive::isBitcodeArchive() { // Make sure the symTab has been loaded. In most cases this should have been // done when the archive was constructed, but still, this is just in case. - if (!symTab.size()) - loadSymbolTable(); + if (symTab.empty()) + if (!loadSymbolTable(0)) + return false; // Now that we know it's been loaded, return true // if it has a size if (symTab.size()) return true; - //We still can't be sure it isn't a bytecode archive - loadArchive(); + // We still can't be sure it isn't a bitcode archive + if (!loadArchive(0)) + return false; std::vector Modules; std::string ErrorMessage; - // Scan the archive, trying to load a bytecode member. We only load one to + // Scan the archive, trying to load a bitcode member. We only load one to // see if this works. for (iterator I = begin(), E = end(); I != E; ++I) { - if (!I->isBytecode() && !I->isCompressedBytecode()) + if (!I->isBitcode()) continue; std::string FullMemberName = - archPath.toString() + "(" + I->getPath().toString() + ")"; - Module* M = ParseBytecodeBuffer((const unsigned char*)I->getData(), - I->getSize(), FullMemberName); + archPath.str() + "(" + I->getPath().str() + ")"; + + MemoryBuffer *Buffer = + MemoryBuffer::getMemBufferCopy(StringRef(I->getData(), I->getSize()), + FullMemberName.c_str()); + Module *M = ParseBitcodeFile(Buffer, Context); + delete Buffer; if (!M) - return false; // Couldn't parse bytecode, not a bytecode archive. + return false; // Couldn't parse bitcode, not a bitcode archive. delete M; return true; }