Home | History | Annotate | Download | only in Archive
      1 //===-- lib/Archive/ArchiveInternals.h -------------------------*- 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 // Internal implementation header for LLVM Archive files.
     11 //
     12 //===----------------------------------------------------------------------===//
     13 
     14 #ifndef LIB_ARCHIVE_ARCHIVEINTERNALS_H
     15 #define LIB_ARCHIVE_ARCHIVEINTERNALS_H
     16 
     17 #include "llvm/ADT/StringExtras.h"
     18 #include "llvm/Bitcode/Archive.h"
     19 #include "llvm/Support/TimeValue.h"
     20 #include <cstring>
     21 
     22 #define ARFILE_MAGIC "!<arch>\n"                   ///< magic string
     23 #define ARFILE_MAGIC_LEN (sizeof(ARFILE_MAGIC)-1)  ///< length of magic string
     24 #define ARFILE_SVR4_SYMTAB_NAME "/               " ///< SVR4 symtab entry name
     25 #define ARFILE_LLVM_SYMTAB_NAME "#_LLVM_SYM_TAB_#" ///< LLVM symtab entry name
     26 #define ARFILE_BSD4_SYMTAB_NAME "__.SYMDEF SORTED" ///< BSD4 symtab entry name
     27 #define ARFILE_STRTAB_NAME      "//              " ///< Name of string table
     28 #define ARFILE_PAD "\n"                            ///< inter-file align padding
     29 #define ARFILE_MEMBER_MAGIC "`\n"                  ///< fmag field magic #
     30 
     31 namespace llvm {
     32 
     33   class LLVMContext;
     34 
     35   /// The ArchiveMemberHeader structure is used internally for bitcode
     36   /// archives.
     37   /// The header precedes each file member in the archive. This structure is
     38   /// defined using character arrays for direct and correct interpretation
     39   /// regardless of the endianess of the machine that produced it.
     40   /// @brief Archive File Member Header
     41   class ArchiveMemberHeader {
     42     /// @name Data
     43     /// @{
     44     public:
     45       char name[16];  ///< Name of the file member.
     46       char date[12];  ///< File date, decimal seconds since Epoch
     47       char uid[6];    ///< user id in ASCII decimal
     48       char gid[6];    ///< group id in ASCII decimal
     49       char mode[8];   ///< file mode in ASCII octal
     50       char size[10];  ///< file size in ASCII decimal
     51       char fmag[2];   ///< Always contains ARFILE_MAGIC_TERMINATOR
     52 
     53     /// @}
     54     /// @name Methods
     55     /// @{
     56     public:
     57     void init() {
     58       memset(name,' ',16);
     59       memset(date,' ',12);
     60       memset(uid,' ',6);
     61       memset(gid,' ',6);
     62       memset(mode,' ',8);
     63       memset(size,' ',10);
     64       fmag[0] = '`';
     65       fmag[1] = '\n';
     66     }
     67 
     68     bool checkSignature() const {
     69       return 0 == memcmp(fmag, ARFILE_MEMBER_MAGIC,2);
     70     }
     71   };
     72 
     73   // Get just the externally visible defined symbols from the bitcode
     74   bool GetBitcodeSymbols(const sys::Path& fName,
     75                           LLVMContext& Context,
     76                           std::vector<std::string>& symbols,
     77                           std::string* ErrMsg);
     78 
     79   Module* GetBitcodeSymbols(const char *Buffer, unsigned Length,
     80                             const std::string& ModuleID,
     81                             LLVMContext& Context,
     82                             std::vector<std::string>& symbols,
     83                             std::string* ErrMsg);
     84 }
     85 
     86 #endif
     87 
     88 // vim: sw=2 ai
     89