lib/Object/Archive.cpp

   1 //===- Archive.cpp - ar File Format implementation --------------*- 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 // This file defines the ArchiveObjectFile class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Object/Archive.h"
  15 #include "llvm/ADT/APInt.h"
  16 #include "llvm/ADT/SmallString.h"
  17 #include "llvm/ADT/Twine.h"
  18 #include "llvm/Support/Endian.h"
  19 #include "llvm/Support/MemoryBuffer.h"
  20
  21 using namespace llvm;
  22 using namespace object;
  23
  24 static const char *const Magic = "!<arch>\n";
  25 static const char *const ThinMagic = "!<thin>\n";
  26
  27 void Archive::anchor() { }
  28
  29 StringRef ArchiveMemberHeader::getName() const {
  30   char EndCond;
  31   if (Name[0] == '/' || Name[0] == '#')
  32     EndCond = ' ';
  33   else
  34     EndCond = '/';
  35   llvm::StringRef::size_type end =
  36       llvm::StringRef(Name, sizeof(Name)).find(EndCond);
  37   if (end == llvm::StringRef::npos)
  38     end = sizeof(Name);
  39   assert(end <= sizeof(Name) && end > 0);
  40   // Don't include the EndCond if there is one.
  41   return llvm::StringRef(Name, end);
  42 }
  43
  44 uint32_t ArchiveMemberHeader::getSize() const {
  45   uint32_t Ret;
  46   if (llvm::StringRef(Size, sizeof(Size)).rtrim(" ").getAsInteger(10, Ret))
  47     llvm_unreachable("Size is not a decimal number.");
  48   return Ret;
  49 }
  50
  51 sys::fs::perms ArchiveMemberHeader::getAccessMode() const {
  52   unsigned Ret;
  53   if (StringRef(AccessMode, sizeof(AccessMode)).rtrim(" ").getAsInteger(8, Ret))
  54     llvm_unreachable("Access mode is not an octal number.");
  55   return static_cast<sys::fs::perms>(Ret);
  56 }
  57
  58 sys::TimeValue ArchiveMemberHeader::getLastModified() const {
  59   unsigned Seconds;
  60   if (StringRef(LastModified, sizeof(LastModified)).rtrim(" ")
  61           .getAsInteger(10, Seconds))
  62     llvm_unreachable("Last modified time not a decimal number.");
  63
  64   sys::TimeValue Ret;
  65   Ret.fromEpochTime(Seconds);
  66   return Ret;
  67 }
  68
  69 unsigned ArchiveMemberHeader::getUID() const {
  70   unsigned Ret;
  71   if (StringRef(UID, sizeof(UID)).rtrim(" ").getAsInteger(10, Ret))
  72     llvm_unreachable("UID time not a decimal number.");
  73   return Ret;
  74 }
  75
  76 unsigned ArchiveMemberHeader::getGID() const {
  77   unsigned Ret;
  78   if (StringRef(GID, sizeof(GID)).rtrim(" ").getAsInteger(10, Ret))
  79     llvm_unreachable("GID time not a decimal number.");
  80   return Ret;
  81 }
  82
  83 Archive::Child::Child(const Archive *Parent, const char *Start)
  84     : Parent(Parent) {
  85   if (!Start)
  86     return;
  87
  88   const ArchiveMemberHeader *Header =
  89       reinterpret_cast<const ArchiveMemberHeader *>(Start);
  90   uint64_t Size = sizeof(ArchiveMemberHeader);
  91   if (!Parent->IsThin || Header->getName() == "/" || Header->getName() == "//")
  92     Size += Header->getSize();
  93   Data = StringRef(Start, Size);
  94
  95   // Setup StartOfFile and PaddingBytes.
  96   StartOfFile = sizeof(ArchiveMemberHeader);
  97   // Don't include attached name.
  98   StringRef Name = Header->getName();
  99   if (Name.startswith("#1/")) {
 100     uint64_t NameSize;
 101     if (Name.substr(3).rtrim(" ").getAsInteger(10, NameSize))
 102       llvm_unreachable("Long name length is not an integer");
 103     StartOfFile += NameSize;
 104   }
 105 }
 106
 107 uint64_t Archive::Child::getSize() const {
 108   if (Parent->IsThin)
 109     return getHeader()->getSize();
 110   return Data.size() - StartOfFile;
 111 }
 112
 113 uint64_t Archive::Child::getRawSize() const {
 114   if (Parent->IsThin)
 115     return getHeader()->getSize();
 116   return Data.size();
 117 }
 118
 119 Archive::Child Archive::Child::getNext() const {
 120   size_t SpaceToSkip = Data.size();
 121   // If it's odd, add 1 to make it even.
 122   if (SpaceToSkip & 1)
 123     ++SpaceToSkip;
 124
 125   const char *NextLoc = Data.data() + SpaceToSkip;
 126
 127   // Check to see if this is past the end of the archive.
 128   if (NextLoc >= Parent->Data.getBufferEnd())
 129     return Child(Parent, nullptr);
 130
 131   return Child(Parent, NextLoc);
 132 }
 133
 134 uint64_t Archive::Child::getChildOffset() const {
 135   const char *a = Parent->Data.getBuffer().data();
 136   const char *c = Data.data();
 137   uint64_t offset = c - a;
 138   return offset;
 139 }
 140
 141 ErrorOr<StringRef> Archive::Child::getName() const {
 142   StringRef name = getRawName();
 143   // Check if it's a special name.
 144   if (name[0] == '/') {
 145     if (name.size() == 1) // Linker member.
 146       return name;
 147     if (name.size() == 2 && name[1] == '/') // String table.
 148       return name;
 149     // It's a long name.
 150     // Get the offset.
 151     std::size_t offset;
 152     if (name.substr(1).rtrim(" ").getAsInteger(10, offset))
 153       llvm_unreachable("Long name offset is not an integer");
 154     const char *addr = Parent->StringTable->Data.begin()
 155                        + sizeof(ArchiveMemberHeader)
 156                        + offset;
 157     // Verify it.
 158     if (Parent->StringTable == Parent->child_end()
 159         || addr < (Parent->StringTable->Data.begin()
 160                    + sizeof(ArchiveMemberHeader))
 161         || addr > (Parent->StringTable->Data.begin()
 162                    + sizeof(ArchiveMemberHeader)
 163                    + Parent->StringTable->getSize()))
 164       return object_error::parse_failed;
 165
 166     // GNU long file names end with a /.
 167     if (Parent->kind() == K_GNU) {
 168       StringRef::size_type End = StringRef(addr).find('/');
 169       return StringRef(addr, End);
 170     }
 171     return StringRef(addr);
 172   } else if (name.startswith("#1/")) {
 173     uint64_t name_size;
 174     if (name.substr(3).rtrim(" ").getAsInteger(10, name_size))
 175       llvm_unreachable("Long name length is not an ingeter");
 176     return Data.substr(sizeof(ArchiveMemberHeader), name_size)
 177         .rtrim(StringRef("\0", 1));
 178   }
 179   // It's a simple name.
 180   if (name[name.size() - 1] == '/')
 181     return name.substr(0, name.size() - 1);
 182   return name;
 183 }
 184
 185 ErrorOr<MemoryBufferRef> Archive::Child::getMemoryBufferRef() const {
 186   ErrorOr<StringRef> NameOrErr = getName();
 187   if (std::error_code EC = NameOrErr.getError())
 188     return EC;
 189   StringRef Name = NameOrErr.get();
 190   return MemoryBufferRef(getBuffer(), Name);
 191 }
 192
 193 ErrorOr<std::unique_ptr<Binary>>
 194 Archive::Child::getAsBinary(LLVMContext *Context) const {
 195   ErrorOr<MemoryBufferRef> BuffOrErr = getMemoryBufferRef();
 196   if (std::error_code EC = BuffOrErr.getError())
 197     return EC;
 198
 199   return createBinary(BuffOrErr.get(), Context);
 200 }
 201
 202 ErrorOr<std::unique_ptr<Archive>> Archive::create(MemoryBufferRef Source) {
 203   std::error_code EC;
 204   std::unique_ptr<Archive> Ret(new Archive(Source, EC));
 205   if (EC)
 206     return EC;
 207   return std::move(Ret);
 208 }
 209
 210 Archive::Archive(MemoryBufferRef Source, std::error_code &ec)
 211     : Binary(Binary::ID_Archive, Source), SymbolTable(child_end()) {
 212   StringRef Buffer = Data.getBuffer();
 213   // Check for sufficient magic.
 214   if (Buffer.startswith(ThinMagic)) {
 215     IsThin = true;
 216   } else if (Buffer.startswith(Magic)) {
 217     IsThin = false;
 218   } else {
 219     ec = object_error::invalid_file_type;
 220     return;
 221   }
 222
 223   // Get the special members.
 224   child_iterator i = child_begin(false);
 225   child_iterator e = child_end();
 226
 227   if (i == e) {
 228     ec = object_error::success;
 229     return;
 230   }
 231
 232   StringRef Name = i->getRawName();
 233
 234   // Below is the pattern that is used to figure out the archive format
 235   // GNU archive format
 236   //  First member : / (may exist, if it exists, points to the symbol table )
 237   //  Second member : // (may exist, if it exists, points to the string table)
 238   //  Note : The string table is used if the filename exceeds 15 characters
 239   // BSD archive format
 240   //  First member : __.SYMDEF or "__.SYMDEF SORTED" (the symbol table)
 241   //  There is no string table, if the filename exceeds 15 characters or has a
 242   //  embedded space, the filename has #1/<size>, The size represents the size
 243   //  of the filename that needs to be read after the archive header
 244   // COFF archive format
 245   //  First member : /
 246   //  Second member : / (provides a directory of symbols)
 247   //  Third member : // (may exist, if it exists, contains the string table)
 248   //  Note: Microsoft PE/COFF Spec 8.3 says that the third member is present
 249   //  even if the string table is empty. However, lib.exe does not in fact
 250   //  seem to create the third member if there's no member whose filename
 251   //  exceeds 15 characters. So the third member is optional.
 252
 253   if (Name == "__.SYMDEF") {
 254     Format = K_BSD;
 255     SymbolTable = i;
 256     ++i;
 257     FirstRegular = i;
 258     ec = object_error::success;
 259     return;
 260   }
 261
 262   if (Name.startswith("#1/")) {
 263     Format = K_BSD;
 264     // We know this is BSD, so getName will work since there is no string table.
 265     ErrorOr<StringRef> NameOrErr = i->getName();
 266     ec = NameOrErr.getError();
 267     if (ec)
 268       return;
 269     Name = NameOrErr.get();
 270     if (Name == "__.SYMDEF SORTED" || Name == "__.SYMDEF") {
 271       SymbolTable = i;
 272       ++i;
 273     }
 274     FirstRegular = i;
 275     return;
 276   }
 277
 278   if (Name == "/") {
 279     SymbolTable = i;
 280
 281     ++i;
 282     if (i == e) {
 283       ec = object_error::parse_failed;
 284       return;
 285     }
 286     Name = i->getRawName();
 287   }
 288
 289   if (Name == "//") {
 290     Format = K_GNU;
 291     StringTable = i;
 292     ++i;
 293     FirstRegular = i;
 294     ec = object_error::success;
 295     return;
 296   }
 297
 298   if (Name[0] != '/') {
 299     Format = K_GNU;
 300     FirstRegular = i;
 301     ec = object_error::success;
 302     return;
 303   }
 304
 305   if (Name != "/") {
 306     ec = object_error::parse_failed;
 307     return;
 308   }
 309
 310   Format = K_COFF;
 311   SymbolTable = i;
 312
 313   ++i;
 314   if (i == e) {
 315     FirstRegular = i;
 316     ec = object_error::success;
 317     return;
 318   }
 319
 320   Name = i->getRawName();
 321
 322   if (Name == "//") {
 323     StringTable = i;
 324     ++i;
 325   }
 326
 327   FirstRegular = i;
 328   ec = object_error::success;
 329 }
 330
 331 Archive::child_iterator Archive::child_begin(bool SkipInternal) const {
 332   if (Data.getBufferSize() == 8) // empty archive.
 333     return child_end();
 334
 335   if (SkipInternal)
 336     return FirstRegular;
 337
 338   const char *Loc = Data.getBufferStart() + strlen(Magic);
 339   Child c(this, Loc);
 340   return c;
 341 }
 342
 343 Archive::child_iterator Archive::child_end() const {
 344   return Child(this, nullptr);
 345 }
 346
 347 StringRef Archive::Symbol::getName() const {
 348   return Parent->SymbolTable->getBuffer().begin() + StringIndex;
 349 }
 350
 351 ErrorOr<Archive::child_iterator> Archive::Symbol::getMember() const {
 352   const char *Buf = Parent->SymbolTable->getBuffer().begin();
 353   const char *Offsets = Buf + 4;
 354   uint32_t Offset = 0;
 355   if (Parent->kind() == K_GNU) {
 356     Offset = *(reinterpret_cast<const support::ubig32_t*>(Offsets)
 357                + SymbolIndex);
 358   } else if (Parent->kind() == K_BSD) {
 359     // The SymbolIndex is an index into the ranlib structs that start at
 360     // Offsets (the first uint32_t is the number of bytes of the ranlib
 361     // structs).  The ranlib structs are a pair of uint32_t's the first
 362     // being a string table offset and the second being the offset into
 363     // the archive of the member that defines the symbol.  Which is what
 364     // is needed here.
 365     Offset = *(reinterpret_cast<const support::ulittle32_t *>(Offsets) +
 366                (SymbolIndex * 2) + 1);
 367   } else {
 368     uint32_t MemberCount = *reinterpret_cast<const support::ulittle32_t*>(Buf);
 369
 370     // Skip offsets.
 371     Buf += sizeof(support::ulittle32_t)
 372            + (MemberCount * sizeof(support::ulittle32_t));
 373
 374     uint32_t SymbolCount = *reinterpret_cast<const support::ulittle32_t*>(Buf);
 375
 376     if (SymbolIndex >= SymbolCount)
 377       return object_error::parse_failed;
 378
 379     // Skip SymbolCount to get to the indices table.
 380     const char *Indices = Buf + sizeof(support::ulittle32_t);
 381
 382     // Get the index of the offset in the file member offset table for this
 383     // symbol.
 384     uint16_t OffsetIndex =
 385       *(reinterpret_cast<const support::ulittle16_t*>(Indices)
 386         + SymbolIndex);
 387     // Subtract 1 since OffsetIndex is 1 based.
 388     --OffsetIndex;
 389
 390     if (OffsetIndex >= MemberCount)
 391       return object_error::parse_failed;
 392
 393     Offset = *(reinterpret_cast<const support::ulittle32_t*>(Offsets)
 394                + OffsetIndex);
 395   }
 396
 397   const char *Loc = Parent->getData().begin() + Offset;
 398   child_iterator Iter(Child(Parent, Loc));
 399   return Iter;
 400 }
 401
 402 Archive::Symbol Archive::Symbol::getNext() const {
 403   Symbol t(*this);
 404   if (Parent->kind() == K_BSD) {
 405     // t.StringIndex is an offset from the start of the __.SYMDEF or
 406     // "__.SYMDEF SORTED" member into the string table for the ranlib
 407     // struct indexed by t.SymbolIndex .  To change t.StringIndex to the
 408     // offset in the string table for t.SymbolIndex+1 we subtract the
 409     // its offset from the start of the string table for t.SymbolIndex
 410     // and add the offset of the string table for t.SymbolIndex+1.
 411
 412     // The __.SYMDEF or "__.SYMDEF SORTED" member starts with a uint32_t
 413     // which is the number of bytes of ranlib structs that follow.  The ranlib
 414     // structs are a pair of uint32_t's the first being a string table offset
 415     // and the second being the offset into the archive of the member that
 416     // define the symbol. After that the next uint32_t is the byte count of
 417     // the string table followed by the string table.
 418     const char *Buf = Parent->SymbolTable->getBuffer().begin();
 419     uint32_t RanlibCount = 0;
 420     RanlibCount = (*reinterpret_cast<const support::ulittle32_t *>(Buf)) /
 421                   (sizeof(uint32_t) * 2);
 422     // If t.SymbolIndex + 1 will be past the count of symbols (the RanlibCount)
 423     // don't change the t.StringIndex as we don't want to reference a ranlib
 424     // past RanlibCount.
 425     if (t.SymbolIndex + 1 < RanlibCount) {
 426       const char *Ranlibs = Buf + 4;
 427       uint32_t CurRanStrx = 0;
 428       uint32_t NextRanStrx = 0;
 429       CurRanStrx = *(reinterpret_cast<const support::ulittle32_t *>(Ranlibs) +
 430                      (t.SymbolIndex * 2));
 431       NextRanStrx = *(reinterpret_cast<const support::ulittle32_t *>(Ranlibs) +
 432                       ((t.SymbolIndex + 1) * 2));
 433       t.StringIndex -= CurRanStrx;
 434       t.StringIndex += NextRanStrx;
 435     }
 436   } else {
 437     // Go to one past next null.
 438     t.StringIndex =
 439         Parent->SymbolTable->getBuffer().find('\0', t.StringIndex) + 1;
 440   }
 441   ++t.SymbolIndex;
 442   return t;
 443 }
 444
 445 Archive::symbol_iterator Archive::symbol_begin() const {
 446   if (!hasSymbolTable())
 447     return symbol_iterator(Symbol(this, 0, 0));
 448
 449   const char *buf = SymbolTable->getBuffer().begin();
 450   if (kind() == K_GNU) {
 451     uint32_t symbol_count = 0;
 452     symbol_count = *reinterpret_cast<const support::ubig32_t*>(buf);
 453     buf += sizeof(uint32_t) + (symbol_count * (sizeof(uint32_t)));
 454   } else if (kind() == K_BSD) {
 455     // The __.SYMDEF or "__.SYMDEF SORTED" member starts with a uint32_t
 456     // which is the number of bytes of ranlib structs that follow.  The ranlib
 457     // structs are a pair of uint32_t's the first being a string table offset
 458     // and the second being the offset into the archive of the member that
 459     // define the symbol. After that the next uint32_t is the byte count of
 460     // the string table followed by the string table.
 461     uint32_t ranlib_count = 0;
 462     ranlib_count = (*reinterpret_cast<const support::ulittle32_t *>(buf)) /
 463                    (sizeof(uint32_t) * 2);
 464     const char *ranlibs = buf + 4;
 465     uint32_t ran_strx = 0;
 466     ran_strx = *(reinterpret_cast<const support::ulittle32_t *>(ranlibs));
 467     buf += sizeof(uint32_t) + (ranlib_count * (2 * (sizeof(uint32_t))));
 468     // Skip the byte count of the string table.
 469     buf += sizeof(uint32_t);
 470     buf += ran_strx;
 471   } else {
 472     uint32_t member_count = 0;
 473     uint32_t symbol_count = 0;
 474     member_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
 475     buf += 4 + (member_count * 4); // Skip offsets.
 476     symbol_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
 477     buf += 4 + (symbol_count * 2); // Skip indices.
 478   }
 479   uint32_t string_start_offset = buf - SymbolTable->getBuffer().begin();
 480   return symbol_iterator(Symbol(this, 0, string_start_offset));
 481 }
 482
 483 Archive::symbol_iterator Archive::symbol_end() const {
 484   if (!hasSymbolTable())
 485     return symbol_iterator(Symbol(this, 0, 0));
 486
 487   const char *buf = SymbolTable->getBuffer().begin();
 488   uint32_t symbol_count = 0;
 489   if (kind() == K_GNU) {
 490     symbol_count = *reinterpret_cast<const support::ubig32_t*>(buf);
 491   } else if (kind() == K_BSD) {
 492     symbol_count = (*reinterpret_cast<const support::ulittle32_t *>(buf)) /
 493                    (sizeof(uint32_t) * 2);
 494   } else {
 495     uint32_t member_count = 0;
 496     member_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
 497     buf += 4 + (member_count * 4); // Skip offsets.
 498     symbol_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
 499   }
 500   return symbol_iterator(
 501     Symbol(this, symbol_count, 0));
 502 }
 503
 504 Archive::child_iterator Archive::findSym(StringRef name) const {
 505   Archive::symbol_iterator bs = symbol_begin();
 506   Archive::symbol_iterator es = symbol_end();
 507
 508   for (; bs != es; ++bs) {
 509     StringRef SymName = bs->getName();
 510     if (SymName == name) {
 511       ErrorOr<Archive::child_iterator> ResultOrErr = bs->getMember();
 512       // FIXME: Should we really eat the error?
 513       if (ResultOrErr.getError())
 514         return child_end();
 515       return ResultOrErr.get();
 516     }
 517   }
 518   return child_end();
 519 }
 520
 521 bool Archive::hasSymbolTable() const {
 522   return SymbolTable != child_end();
 523 }