llvm.org GIT mirror llvm / release_36 include / llvm / Object / Archive.h
release_36

Tree @release_36 (Download .tar.gz)

Archive.h @release_36

a51d7d9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1b27914
255f89f
0f76e64
3d21815
9941bdd
0f76e64
a51d7d9
 
 
0f76e64
 
 
 
 
 
 
 
 
5263d0a
 
 
2012593
 
9941bdd
 
 
 
 
0f76e64
 
a51d7d9
2d24e2a
a51d7d9
 
5861893
0f76e64
a51d7d9
0f76e64
 
a51d7d9
c5f8757
 
 
 
a51d7d9
be6b910
a51d7d9
 
92f7386
 
a51d7d9
 
8a2549f
 
 
 
5263d0a
0f76e64
0659928
c5f8757
9941bdd
 
 
 
 
 
 
 
0f76e64
96b7967
0f76e64
 
 
 
 
548f2b6
a51d7d9
0659928
 
a51d7d9
 
 
 
5c1c055
a51d7d9
0b6cb71
a51d7d9
5c1c055
 
a51d7d9
 
 
 
 
 
 
 
 
5c1c055
8a2549f
 
 
5c1c055
a51d7d9
 
 
 
 
c8a55a6
 
 
 
 
 
 
 
 
 
 
 
 
 
0659928
 
c8a55a6
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
548f2b6
 
a51d7d9
206252c
 
 
 
 
 
96b7967
206252c
94ad5a1
 
5c1c055
 
 
 
a51d7d9
94ad5a1
 
c8a55a6
a51d7d9
 
6f9489a
a51d7d9
 
206252c
 
 
cf48cf2
 
a51d7d9
c8a55a6
a51d7d9
34ac52d
96b7967
 
a51d7d9
 
 
 
 
 
//===- Archive.h - ar archive file format -----------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file declares the ar archive file format class.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_OBJECT_ARCHIVE_H
#define LLVM_OBJECT_ARCHIVE_H

#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/iterator_range.h"
#include "llvm/Object/Binary.h"
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/ErrorOr.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/MemoryBuffer.h"

namespace llvm {
namespace object {
struct ArchiveMemberHeader {
  char Name[16];
  char LastModified[12];
  char UID[6];
  char GID[6];
  char AccessMode[8];
  char Size[10]; ///< Size of data, not including header or padding.
  char Terminator[2];

  /// Get the name without looking up long names.
  llvm::StringRef getName() const;

  /// Members are not larger than 4GB.
  uint32_t getSize() const;

  sys::fs::perms getAccessMode() const;
  sys::TimeValue getLastModified() const;
  unsigned getUID() const;
  unsigned getGID() const;
};

class Archive : public Binary {
  virtual void anchor();
public:
  class Child {
    const Archive *Parent;
    /// \brief Includes header but not padding byte.
    StringRef Data;
    /// \brief Offset from Data to the start of the file.
    uint16_t StartOfFile;

    const ArchiveMemberHeader *getHeader() const {
      return reinterpret_cast<const ArchiveMemberHeader *>(Data.data());
    }

  public:
    Child(const Archive *Parent, const char *Start);

    bool operator ==(const Child &other) const {
      assert(Parent == other.Parent);
      return Data.begin() == other.Data.begin();
    }

    bool operator <(const Child &other) const {
      return Data.begin() < other.Data.begin();
    }

    Child getNext() const;

    ErrorOr<StringRef> getName() const;
    StringRef getRawName() const { return getHeader()->getName(); }
    sys::TimeValue getLastModified() const {
      return getHeader()->getLastModified();
    }
    unsigned getUID() const { return getHeader()->getUID(); }
    unsigned getGID() const { return getHeader()->getGID(); }
    sys::fs::perms getAccessMode() const {
      return getHeader()->getAccessMode();
    }
    /// \return the size of the archive member without the header or padding.
    uint64_t getSize() const;

    StringRef getBuffer() const {
      return StringRef(Data.data() + StartOfFile, getSize());
    }

    ErrorOr<MemoryBufferRef> getMemoryBufferRef() const;

    ErrorOr<std::unique_ptr<Binary>>
    getAsBinary(LLVMContext *Context = nullptr) const;
  };

  class child_iterator {
    Child child;

  public:
    child_iterator() : child(Child(nullptr, nullptr)) {}
    child_iterator(const Child &c) : child(c) {}
    const Child *operator->() const { return &child; }
    const Child &operator*() const { return child; }

    bool operator==(const child_iterator &other) const {
      return child == other.child;
    }

    bool operator!=(const child_iterator &other) const {
      return !(*this == other);
    }

    bool operator<(const child_iterator &other) const {
      return child < other.child;
    }

    child_iterator &operator++() { // Preincrement
      child = child.getNext();
      return *this;
    }
  };

  class Symbol {
    const Archive *Parent;
    uint32_t SymbolIndex;
    uint32_t StringIndex; // Extra index to the string.

  public:
    bool operator ==(const Symbol &other) const {
      return (Parent == other.Parent) && (SymbolIndex == other.SymbolIndex);
    }

    Symbol(const Archive *p, uint32_t symi, uint32_t stri)
      : Parent(p)
      , SymbolIndex(symi)
      , StringIndex(stri) {}
    StringRef getName() const;
    ErrorOr<child_iterator> getMember() const;
    Symbol getNext() const;
  };

  class symbol_iterator {
    Symbol symbol;
  public:
    symbol_iterator(const Symbol &s) : symbol(s) {}
    const Symbol *operator->() const {
      return &symbol;
    }

    bool operator==(const symbol_iterator &other) const {
      return symbol == other.symbol;
    }

    bool operator!=(const symbol_iterator &other) const {
      return !(*this == other);
    }

    symbol_iterator& operator++() {  // Preincrement
      symbol = symbol.getNext();
      return *this;
    }
  };

  Archive(MemoryBufferRef Source, std::error_code &EC);
  static ErrorOr<std::unique_ptr<Archive>> create(MemoryBufferRef Source);

  enum Kind {
    K_GNU,
    K_BSD,
    K_COFF
  };

  Kind kind() const { return (Kind)Format; }

  child_iterator child_begin(bool SkipInternal = true) const;
  child_iterator child_end() const;
  iterator_range<child_iterator> children(bool SkipInternal = true) const {
    return iterator_range<child_iterator>(child_begin(SkipInternal),
                                          child_end());
  }

  symbol_iterator symbol_begin() const;
  symbol_iterator symbol_end() const;

  // Cast methods.
  static inline bool classof(Binary const *v) {
    return v->isArchive();
  }

  // check if a symbol is in the archive
  child_iterator findSym(StringRef name) const;

  bool hasSymbolTable() const;

private:
  child_iterator SymbolTable;
  child_iterator StringTable;
  child_iterator FirstRegular;
  unsigned Format : 2;
  unsigned IsThin : 1;
};

}
}

#endif