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/Support/Endian.h"
  17 #include "llvm/Support/MemoryBuffer.h"
  18
  19 using namespace llvm;
  20 using namespace object;
  21
  22 static const char *Magic = "!<arch>\n";
  23
  24 static bool isInternalMember(const ArchiveMemberHeader &amh) {
  25   static const char *const internals[] = {
  26     "/",
  27     "//",
  28     "#_LLVM_SYM_TAB_#"
  29   };
  30
  31   StringRef name = amh.getName();
  32   for (std::size_t i = 0; i < sizeof(internals) / sizeof(*internals); ++i) {
  33     if (name == internals[i])
  34       return true;
  35   }
  36   return false;
  37 }
  38
  39 void Archive::anchor() { }
  40
  41 error_code Archive::Child::getName(StringRef &Result) const {
  42   StringRef name = ToHeader(Data.data())->getName();
  43   // Check if it's a special name.
  44   if (name[0] == '/') {
  45     if (name.size() == 1) { // Linker member.
  46       Result = name;
  47       return object_error::success;
  48     }
  49     if (name.size() == 2 && name[1] == '/') { // String table.
  50       Result = name;
  51       return object_error::success;
  52     }
  53     // It's a long name.
  54     // Get the offset.
  55     std::size_t offset;
  56     if (name.substr(1).rtrim(" ").getAsInteger(10, offset))
  57       llvm_unreachable("Long name offset is not an integer");
  58     const char *addr = Parent->StringTable->Data.begin()
  59                        + sizeof(ArchiveMemberHeader)
  60                        + offset;
  61     // Verify it.
  62     if (Parent->StringTable == Parent->end_children()
  63         || addr < (Parent->StringTable->Data.begin()
  64                    + sizeof(ArchiveMemberHeader))
  65         || addr > (Parent->StringTable->Data.begin()
  66                    + sizeof(ArchiveMemberHeader)
  67                    + Parent->StringTable->getSize()))
  68       return object_error::parse_failed;
  69
  70     // GNU long file names end with a /.
  71     if (Parent->kind() == K_GNU) {
  72       StringRef::size_type End = StringRef(addr).find('/');
  73       Result = StringRef(addr, End);
  74     } else {
  75       Result = addr;
  76     }
  77     return object_error::success;
  78   } else if (name.startswith("#1/")) {
  79     uint64_t name_size;
  80     if (name.substr(3).rtrim(" ").getAsInteger(10, name_size))
  81       llvm_unreachable("Long name length is not an ingeter");
  82     Result = Data.substr(sizeof(ArchiveMemberHeader), name_size);
  83     return object_error::success;
  84   }
  85   // It's a simple name.
  86   if (name[name.size() - 1] == '/')
  87     Result = name.substr(0, name.size() - 1);
  88   else
  89     Result = name;
  90   return object_error::success;
  91 }
  92
  93 error_code Archive::Child::getAsBinary(OwningPtr<Binary> &Result) const {
  94   OwningPtr<Binary> ret;
  95   OwningPtr<MemoryBuffer> Buff;
  96   if (error_code ec = getMemoryBuffer(Buff))
  97     return ec;
  98   if (error_code ec = createBinary(Buff.take(), ret))
  99     return ec;
 100   Result.swap(ret);
 101   return object_error::success;
 102 }
 103
 104 Archive::Archive(MemoryBuffer *source, error_code &ec)
 105   : Binary(Binary::ID_Archive, source) {
 106   // Check for sufficient magic.
 107   if (!source || source->getBufferSize()
 108                  < (8 + sizeof(ArchiveMemberHeader) + 2) // Smallest archive.
 109               || StringRef(source->getBufferStart(), 8) != Magic) {
 110     ec = object_error::invalid_file_type;
 111     return;
 112   }
 113
 114   // Get the special members.
 115   child_iterator i = begin_children(false);
 116   child_iterator e = end_children();
 117
 118   StringRef name;
 119   if ((ec = i->getName(name)))
 120     return;
 121
 122   // Below is the pattern that is used to figure out the archive format
 123   // GNU archive format
 124   //  First member : / (points to the symbol table )
 125   //  Second member : // (may exist, if it exists, points to the string table)
 126   //  Note : The string table is used if the filename exceeds 15 characters
 127   // BSD archive format
 128   //  First member : __.SYMDEF (points to the symbol table)
 129   //  There is no string table, if the filename exceeds 15 characters or has a
 130   //  embedded space, the filename has #1/<size>, The size represents the size
 131   //  of the filename that needs to be read after the archive header
 132   // COFF archive format
 133   //  First member : /
 134   //  Second member : / (provides a directory of symbols)
 135   //  Third member : // (may exist, if it exists, contains the string table)
 136   //  Note: Microsoft PE/COFF Spec 8.3 says that the third member is present
 137   //  even if the string table is empty. However, lib.exe does not in fact
 138   //  seem to create the third member if there's no member whose filename
 139   //  exceeds 15 characters. So the third member is optional.
 140   if (name == "/") {
 141     SymbolTable = i;
 142     StringTable = e;
 143     if (i != e) ++i;
 144     if (i == e) {
 145       ec = object_error::parse_failed;
 146       return;
 147     }
 148     if ((ec = i->getName(name)))
 149       return;
 150     if (name[0] != '/') {
 151       Format = K_GNU;
 152     } else if ((name.size() > 1) && (name == "//")) {
 153       Format = K_GNU;
 154       StringTable = i;
 155       ++i;
 156     } else {
 157       Format = K_COFF;
 158       if (i != e) {
 159         SymbolTable = i;
 160         ++i;
 161       }
 162       if (i != e) {
 163         if ((ec = i->getName(name)))
 164           return;
 165         if (name == "//")
 166           StringTable = i;
 167       }
 168     }
 169   } else if (name == "__.SYMDEF") {
 170     Format = K_BSD;
 171     SymbolTable = i;
 172     StringTable = e;
 173   }
 174   ec = object_error::success;
 175 }
 176
 177 Archive::child_iterator Archive::begin_children(bool skip_internal) const {
 178   const char *Loc = Data->getBufferStart() + strlen(Magic);
 179   size_t Size = sizeof(ArchiveMemberHeader) +
 180     ToHeader(Loc)->getSize();
 181   Child c(this, StringRef(Loc, Size));
 182   // Skip internals at the beginning of an archive.
 183   if (skip_internal && isInternalMember(*ToHeader(Loc)))
 184     return c.getNext();
 185   return c;
 186 }
 187
 188 Archive::child_iterator Archive::end_children() const {
 189   return Child(this, StringRef(0, 0));
 190 }
 191
 192 error_code Archive::Symbol::getName(StringRef &Result) const {
 193   Result = StringRef(Parent->SymbolTable->getBuffer().begin() + StringIndex);
 194   return object_error::success;
 195 }
 196
 197 error_code Archive::Symbol::getMember(child_iterator &Result) const {
 198   const char *Buf = Parent->SymbolTable->getBuffer().begin();
 199   const char *Offsets = Buf + 4;
 200   uint32_t Offset = 0;
 201   if (Parent->kind() == K_GNU) {
 202     Offset = *(reinterpret_cast<const support::ubig32_t*>(Offsets)
 203                + SymbolIndex);
 204   } else if (Parent->kind() == K_BSD) {
 205     llvm_unreachable("BSD format is not supported");
 206   } else {
 207     uint32_t MemberCount = *reinterpret_cast<const support::ulittle32_t*>(Buf);
 208
 209     // Skip offsets.
 210     Buf += sizeof(support::ulittle32_t)
 211            + (MemberCount * sizeof(support::ulittle32_t));
 212
 213     uint32_t SymbolCount = *reinterpret_cast<const support::ulittle32_t*>(Buf);
 214
 215     if (SymbolIndex >= SymbolCount)
 216       return object_error::parse_failed;
 217
 218     // Skip SymbolCount to get to the indices table.
 219     const char *Indices = Buf + sizeof(support::ulittle32_t);
 220
 221     // Get the index of the offset in the file member offset table for this
 222     // symbol.
 223     uint16_t OffsetIndex =
 224       *(reinterpret_cast<const support::ulittle16_t*>(Indices)
 225         + SymbolIndex);
 226     // Subtract 1 since OffsetIndex is 1 based.
 227     --OffsetIndex;
 228
 229     if (OffsetIndex >= MemberCount)
 230       return object_error::parse_failed;
 231
 232     Offset = *(reinterpret_cast<const support::ulittle32_t*>(Offsets)
 233                + OffsetIndex);
 234   }
 235
 236   const char *Loc = Parent->getData().begin() + Offset;
 237   size_t Size = sizeof(ArchiveMemberHeader) +
 238     ToHeader(Loc)->getSize();
 239   Result = Child(Parent, StringRef(Loc, Size));
 240
 241   return object_error::success;
 242 }
 243
 244 Archive::Symbol Archive::Symbol::getNext() const {
 245   Symbol t(*this);
 246   // Go to one past next null.
 247   t.StringIndex =
 248       Parent->SymbolTable->getBuffer().find('\0', t.StringIndex) + 1;
 249   ++t.SymbolIndex;
 250   return t;
 251 }
 252
 253 Archive::symbol_iterator Archive::begin_symbols() const {
 254   const char *buf = SymbolTable->getBuffer().begin();
 255   if (kind() == K_GNU) {
 256     uint32_t symbol_count = 0;
 257     symbol_count = *reinterpret_cast<const support::ubig32_t*>(buf);
 258     buf += sizeof(uint32_t) + (symbol_count * (sizeof(uint32_t)));
 259   } else if (kind() == K_BSD) {
 260     llvm_unreachable("BSD archive format is not supported");
 261   } else {
 262     uint32_t member_count = 0;
 263     uint32_t symbol_count = 0;
 264     member_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
 265     buf += 4 + (member_count * 4); // Skip offsets.
 266     symbol_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
 267     buf += 4 + (symbol_count * 2); // Skip indices.
 268   }
 269   uint32_t string_start_offset = buf - SymbolTable->getBuffer().begin();
 270   return symbol_iterator(Symbol(this, 0, string_start_offset));
 271 }
 272
 273 Archive::symbol_iterator Archive::end_symbols() const {
 274   const char *buf = SymbolTable->getBuffer().begin();
 275   uint32_t symbol_count = 0;
 276   if (kind() == K_GNU) {
 277     symbol_count = *reinterpret_cast<const support::ubig32_t*>(buf);
 278     buf += sizeof(uint32_t) + (symbol_count * (sizeof(uint32_t)));
 279   } else if (kind() == K_BSD) {
 280     llvm_unreachable("BSD archive format is not supported");
 281   } else {
 282     uint32_t member_count = 0;
 283     member_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
 284     buf += 4 + (member_count * 4); // Skip offsets.
 285     symbol_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
 286   }
 287   return symbol_iterator(
 288     Symbol(this, symbol_count, 0));
 289 }
 290
 291 Archive::child_iterator Archive::findSym(StringRef name) const {
 292   Archive::symbol_iterator bs = begin_symbols();
 293   Archive::symbol_iterator es = end_symbols();
 294   Archive::child_iterator result;
 295
 296   StringRef symname;
 297   for (; bs != es; ++bs) {
 298     if (bs->getName(symname))
 299         return end_children();
 300     if (symname == name) {
 301       if (bs->getMember(result))
 302         return end_children();
 303       return result;
 304     }
 305   }
 306   return end_children();
 307 }