1 //===- Archive.cpp - ar File Format implementation --------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the ArchiveObjectFile class.
12 //===----------------------------------------------------------------------===//
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"
22 using namespace object;
24 static const char *const Magic = "!<arch>\n";
26 void Archive::anchor() { }
28 StringRef ArchiveMemberHeader::getName() const {
30 if (Name[0] == '/' || Name[0] == '#')
34 llvm::StringRef::size_type end =
35 llvm::StringRef(Name, sizeof(Name)).find(EndCond);
36 if (end == llvm::StringRef::npos)
38 assert(end <= sizeof(Name) && end > 0);
39 // Don't include the EndCond if there is one.
40 return llvm::StringRef(Name, end);
43 uint32_t ArchiveMemberHeader::getSize() const {
45 if (llvm::StringRef(Size, sizeof(Size)).rtrim(" ").getAsInteger(10, Ret))
46 llvm_unreachable("Size is not a decimal number.");
50 sys::fs::perms ArchiveMemberHeader::getAccessMode() const {
52 if (StringRef(AccessMode, sizeof(AccessMode)).rtrim(" ").getAsInteger(8, Ret))
53 llvm_unreachable("Access mode is not an octal number.");
54 return static_cast<sys::fs::perms>(Ret);
57 sys::TimeValue ArchiveMemberHeader::getLastModified() const {
59 if (StringRef(LastModified, sizeof(LastModified)).rtrim(" ")
60 .getAsInteger(10, Seconds))
61 llvm_unreachable("Last modified time not a decimal number.");
64 Ret.fromEpochTime(Seconds);
68 unsigned ArchiveMemberHeader::getUID() const {
70 if (StringRef(UID, sizeof(UID)).rtrim(" ").getAsInteger(10, Ret))
71 llvm_unreachable("UID time not a decimal number.");
75 unsigned ArchiveMemberHeader::getGID() const {
77 if (StringRef(GID, sizeof(GID)).rtrim(" ").getAsInteger(10, Ret))
78 llvm_unreachable("GID time not a decimal number.");
82 Archive::Child::Child(const Archive *Parent, const char *Start)
87 const ArchiveMemberHeader *Header =
88 reinterpret_cast<const ArchiveMemberHeader *>(Start);
89 Data = StringRef(Start, sizeof(ArchiveMemberHeader) + Header->getSize());
91 // Setup StartOfFile and PaddingBytes.
92 StartOfFile = sizeof(ArchiveMemberHeader);
93 // Don't include attached name.
94 StringRef Name = Header->getName();
95 if (Name.startswith("#1/")) {
97 if (Name.substr(3).rtrim(" ").getAsInteger(10, NameSize))
98 llvm_unreachable("Long name length is not an integer");
99 StartOfFile += NameSize;
103 Archive::Child Archive::Child::getNext() const {
104 size_t SpaceToSkip = Data.size();
105 // If it's odd, add 1 to make it even.
109 const char *NextLoc = Data.data() + SpaceToSkip;
111 // Check to see if this is past the end of the archive.
112 if (NextLoc >= Parent->Data->getBufferEnd())
113 return Child(Parent, nullptr);
115 return Child(Parent, NextLoc);
118 error_code Archive::Child::getName(StringRef &Result) const {
119 StringRef name = getRawName();
120 // Check if it's a special name.
121 if (name[0] == '/') {
122 if (name.size() == 1) { // Linker member.
124 return object_error::success;
126 if (name.size() == 2 && name[1] == '/') { // String table.
128 return object_error::success;
133 if (name.substr(1).rtrim(" ").getAsInteger(10, offset))
134 llvm_unreachable("Long name offset is not an integer");
135 const char *addr = Parent->StringTable->Data.begin()
136 + sizeof(ArchiveMemberHeader)
139 if (Parent->StringTable == Parent->child_end()
140 || addr < (Parent->StringTable->Data.begin()
141 + sizeof(ArchiveMemberHeader))
142 || addr > (Parent->StringTable->Data.begin()
143 + sizeof(ArchiveMemberHeader)
144 + Parent->StringTable->getSize()))
145 return object_error::parse_failed;
147 // GNU long file names end with a /.
148 if (Parent->kind() == K_GNU) {
149 StringRef::size_type End = StringRef(addr).find('/');
150 Result = StringRef(addr, End);
154 return object_error::success;
155 } else if (name.startswith("#1/")) {
157 if (name.substr(3).rtrim(" ").getAsInteger(10, name_size))
158 llvm_unreachable("Long name length is not an ingeter");
159 Result = Data.substr(sizeof(ArchiveMemberHeader), name_size)
160 .rtrim(StringRef("\0", 1));
161 return object_error::success;
163 // It's a simple name.
164 if (name[name.size() - 1] == '/')
165 Result = name.substr(0, name.size() - 1);
168 return object_error::success;
171 error_code Archive::Child::getMemoryBuffer(std::unique_ptr<MemoryBuffer> &Result,
172 bool FullPath) const {
174 if (error_code ec = getName(Name))
176 SmallString<128> Path;
177 Result.reset(MemoryBuffer::getMemBuffer(
178 getBuffer(), FullPath ? (Twine(Parent->getFileName()) + "(" + Name + ")")
185 error_code Archive::Child::getAsBinary(std::unique_ptr<Binary> &Result,
186 LLVMContext *Context) const {
187 std::unique_ptr<Binary> ret;
188 std::unique_ptr<MemoryBuffer> Buff;
189 if (error_code ec = getMemoryBuffer(Buff))
191 ErrorOr<Binary *> BinaryOrErr = createBinary(Buff.release(), Context);
192 if (error_code EC = BinaryOrErr.getError())
194 Result.reset(BinaryOrErr.get());
195 return object_error::success;
198 ErrorOr<Archive*> Archive::create(MemoryBuffer *Source) {
200 std::unique_ptr<Archive> Ret(new Archive(Source, EC));
203 return Ret.release();
206 Archive::Archive(MemoryBuffer *source, error_code &ec)
207 : Binary(Binary::ID_Archive, source), SymbolTable(child_end()) {
208 // Check for sufficient magic.
210 if (source->getBufferSize() < 8 ||
211 StringRef(source->getBufferStart(), 8) != Magic) {
212 ec = object_error::invalid_file_type;
216 // Get the special members.
217 child_iterator i = child_begin(false);
218 child_iterator e = child_end();
221 ec = object_error::success;
225 StringRef Name = i->getRawName();
227 // Below is the pattern that is used to figure out the archive format
228 // GNU archive format
229 // First member : / (may exist, if it exists, points to the symbol table )
230 // Second member : // (may exist, if it exists, points to the string table)
231 // Note : The string table is used if the filename exceeds 15 characters
232 // BSD archive format
233 // First member : __.SYMDEF or "__.SYMDEF SORTED" (the symbol table)
234 // There is no string table, if the filename exceeds 15 characters or has a
235 // embedded space, the filename has #1/<size>, The size represents the size
236 // of the filename that needs to be read after the archive header
237 // COFF archive format
239 // Second member : / (provides a directory of symbols)
240 // Third member : // (may exist, if it exists, contains the string table)
241 // Note: Microsoft PE/COFF Spec 8.3 says that the third member is present
242 // even if the string table is empty. However, lib.exe does not in fact
243 // seem to create the third member if there's no member whose filename
244 // exceeds 15 characters. So the third member is optional.
246 if (Name == "__.SYMDEF") {
251 ec = object_error::success;
255 if (Name.startswith("#1/")) {
257 // We know this is BSD, so getName will work since there is no string table.
258 ec = i->getName(Name);
261 if (Name == "__.SYMDEF SORTED") {
274 ec = object_error::parse_failed;
277 Name = i->getRawName();
285 ec = object_error::success;
289 if (Name[0] != '/') {
292 ec = object_error::success;
297 ec = object_error::parse_failed;
307 ec = object_error::success;
311 Name = i->getRawName();
319 ec = object_error::success;
322 Archive::child_iterator Archive::child_begin(bool SkipInternal) const {
323 if (Data->getBufferSize() == 8) // empty archive.
329 const char *Loc = Data->getBufferStart() + strlen(Magic);
334 Archive::child_iterator Archive::child_end() const {
335 return Child(this, nullptr);
338 error_code Archive::Symbol::getName(StringRef &Result) const {
339 Result = StringRef(Parent->SymbolTable->getBuffer().begin() + StringIndex);
340 return object_error::success;
343 error_code Archive::Symbol::getMember(child_iterator &Result) const {
344 const char *Buf = Parent->SymbolTable->getBuffer().begin();
345 const char *Offsets = Buf + 4;
347 if (Parent->kind() == K_GNU) {
348 Offset = *(reinterpret_cast<const support::ubig32_t*>(Offsets)
350 } else if (Parent->kind() == K_BSD) {
351 llvm_unreachable("BSD format is not supported");
353 uint32_t MemberCount = *reinterpret_cast<const support::ulittle32_t*>(Buf);
356 Buf += sizeof(support::ulittle32_t)
357 + (MemberCount * sizeof(support::ulittle32_t));
359 uint32_t SymbolCount = *reinterpret_cast<const support::ulittle32_t*>(Buf);
361 if (SymbolIndex >= SymbolCount)
362 return object_error::parse_failed;
364 // Skip SymbolCount to get to the indices table.
365 const char *Indices = Buf + sizeof(support::ulittle32_t);
367 // Get the index of the offset in the file member offset table for this
369 uint16_t OffsetIndex =
370 *(reinterpret_cast<const support::ulittle16_t*>(Indices)
372 // Subtract 1 since OffsetIndex is 1 based.
375 if (OffsetIndex >= MemberCount)
376 return object_error::parse_failed;
378 Offset = *(reinterpret_cast<const support::ulittle32_t*>(Offsets)
382 const char *Loc = Parent->getData().begin() + Offset;
383 Result = Child(Parent, Loc);
385 return object_error::success;
388 Archive::Symbol Archive::Symbol::getNext() const {
390 // Go to one past next null.
392 Parent->SymbolTable->getBuffer().find('\0', t.StringIndex) + 1;
397 Archive::symbol_iterator Archive::symbol_begin() const {
398 if (!hasSymbolTable())
399 return symbol_iterator(Symbol(this, 0, 0));
401 const char *buf = SymbolTable->getBuffer().begin();
402 if (kind() == K_GNU) {
403 uint32_t symbol_count = 0;
404 symbol_count = *reinterpret_cast<const support::ubig32_t*>(buf);
405 buf += sizeof(uint32_t) + (symbol_count * (sizeof(uint32_t)));
406 } else if (kind() == K_BSD) {
407 llvm_unreachable("BSD archive format is not supported");
409 uint32_t member_count = 0;
410 uint32_t symbol_count = 0;
411 member_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
412 buf += 4 + (member_count * 4); // Skip offsets.
413 symbol_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
414 buf += 4 + (symbol_count * 2); // Skip indices.
416 uint32_t string_start_offset = buf - SymbolTable->getBuffer().begin();
417 return symbol_iterator(Symbol(this, 0, string_start_offset));
420 Archive::symbol_iterator Archive::symbol_end() const {
421 if (!hasSymbolTable())
422 return symbol_iterator(Symbol(this, 0, 0));
424 const char *buf = SymbolTable->getBuffer().begin();
425 uint32_t symbol_count = 0;
426 if (kind() == K_GNU) {
427 symbol_count = *reinterpret_cast<const support::ubig32_t*>(buf);
428 } else if (kind() == K_BSD) {
429 llvm_unreachable("BSD archive format is not supported");
431 uint32_t member_count = 0;
432 member_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
433 buf += 4 + (member_count * 4); // Skip offsets.
434 symbol_count = *reinterpret_cast<const support::ulittle32_t*>(buf);
436 return symbol_iterator(
437 Symbol(this, symbol_count, 0));
440 Archive::child_iterator Archive::findSym(StringRef name) const {
441 Archive::symbol_iterator bs = symbol_begin();
442 Archive::symbol_iterator es = symbol_end();
443 Archive::child_iterator result;
446 for (; bs != es; ++bs) {
447 if (bs->getName(symname))
449 if (symname == name) {
450 if (bs->getMember(result))
458 bool Archive::hasSymbolTable() const {
459 return SymbolTable != child_end();