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