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->Size = MemberSize;
 179   member->ModTime.fromEpochTime(atoi(Hdr->date));
 180   unsigned int mode;
 181   sscanf(Hdr->mode, "%o", &mode);
 182   member->Mode = mode;
 183   member->User = atoi(Hdr->uid);
 184   member->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   const char *At = base;
 211   const char *End = mapfile->getBufferEnd();
 212
 213   if (!checkSignature(error))
 214     return false;
 215
 216   At += 8;  // Skip the magic string.
 217
 218   bool foundFirstFile = false;
 219   while (At < End) {
 220     // parse the member header
 221     const char* Save = At;
 222     ArchiveMember* mbr = parseMemberHeader(At, End, error);
 223     if (!mbr)
 224       return false;
 225
 226     // check if this is the foreign symbol table
 227     if (mbr->isSVR4SymbolTable() || mbr->isBSD4SymbolTable()) {
 228       At += mbr->getSize();
 229       if ((intptr_t(At) & 1) == 1)
 230         At++;
 231     } else if (mbr->isStringTable()) {
 232       // Simply suck the entire string table into a string
 233       // variable. This will be used to get the names of the
 234       // members that use the "/ddd" format for their names
 235       // (SVR4 style long names).
 236       strtab.assign(At, mbr->getSize());
 237       At += mbr->getSize();
 238       if ((intptr_t(At) & 1) == 1)
 239         At++;
 240       delete mbr;
 241     } else {
 242       // This is just a regular file. If its the first one, save its offset.
 243       // Otherwise just push it on the list and move on to the next file.
 244       if (!foundFirstFile) {
 245         firstFileOffset = Save - base;
 246         foundFirstFile = true;
 247       }
 248       members.push_back(mbr);
 249       At += mbr->getSize();
 250       if ((intptr_t(At) & 1) == 1)
 251         At++;
 252     }
 253   }
 254   return true;
 255 }
 256
 257 // Open and completely load the archive file.
 258 Archive*
 259 Archive::OpenAndLoad(StringRef File, LLVMContext& C,
 260                      std::string* ErrorMessage) {
 261   OwningPtr<Archive> result(new Archive(File, C));
 262   if (result->mapToMemory(ErrorMessage))
 263     return NULL;
 264   if (!result->loadArchive(ErrorMessage))
 265     return NULL;
 266   return result.take();
 267 }
 268
 269 // Load just the symbol table from the archive file
 270 bool
 271 Archive::loadSymbolTable(std::string* ErrorMsg) {
 272
 273   // Set up parsing
 274   members.clear();
 275   const char *At = base;
 276   const char *End = mapfile->getBufferEnd();
 277
 278   // Make sure we're dealing with an archive
 279   if (!checkSignature(ErrorMsg))
 280     return false;
 281
 282   At += 8; // Skip signature
 283
 284   // Parse the first file member header
 285   const char* FirstFile = At;
 286   ArchiveMember* mbr = parseMemberHeader(At, End, ErrorMsg);
 287   if (!mbr)
 288     return false;
 289
 290   if (mbr->isSVR4SymbolTable() || mbr->isBSD4SymbolTable()) {
 291     // Skip the foreign symbol table, we don't do anything with it
 292     At += mbr->getSize();
 293     if ((intptr_t(At) & 1) == 1)
 294       At++;
 295     delete mbr;
 296
 297     // Read the next one
 298     FirstFile = At;
 299     mbr = parseMemberHeader(At, End, ErrorMsg);
 300     if (!mbr) {
 301       delete mbr;
 302       return false;
 303     }
 304   }
 305
 306   if (mbr->isStringTable()) {
 307     // Process the string table entry
 308     strtab.assign((const char*)mbr->getData(), mbr->getSize());
 309     At += mbr->getSize();
 310     if ((intptr_t(At) & 1) == 1)
 311       At++;
 312     delete mbr;
 313     // Get the next one
 314     FirstFile = At;
 315     mbr = parseMemberHeader(At, End, ErrorMsg);
 316     if (!mbr) {
 317       delete mbr;
 318       return false;
 319     }
 320   }
 321
 322   // There's no symbol table in the file. We have to rebuild it from scratch
 323   // because the intent of this method is to get the symbol table loaded so
 324   // it can be searched efficiently.
 325   // Add the member to the members list
 326   members.push_back(mbr);
 327
 328   firstFileOffset = FirstFile - base;
 329   return true;
 330 }