tools/llvm-ar/Archive.h

   1 //===-- llvm/Bitcode/Archive.h - LLVM Bitcode Archive -----------*- 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 header file declares the Archive and ArchiveMember classes that provide
  11 // manipulation of LLVM Archive files.  The implementation is provided by the
  12 // lib/Bitcode/Archive library.  This library is used to read and write
  13 // archive (*.a) files that contain LLVM bitcode files (or others).
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef TOOLS_LLVM_AR_ARCHIVE_H
  18 #define TOOLS_LLVM_AR_ARCHIVE_H
  19
  20 #include "llvm/ADT/ilist.h"
  21 #include "llvm/ADT/ilist_node.h"
  22 #include "llvm/Support/Path.h"
  23 #include "llvm/Support/TimeValue.h"
  24 #include <map>
  25 #include <set>
  26 #include <vector>
  27
  28 namespace llvm {
  29   class MemoryBuffer;
  30
  31 // Forward declare classes
  32 class Module;              // From VMCore
  33 class Archive;             // Declared below
  34 class ArchiveMemberHeader; // Internal implementation class
  35 class LLVMContext;         // Global data
  36
  37 /// This class is the main class manipulated by users of the Archive class. It
  38 /// holds information about one member of the Archive. It is also the element
  39 /// stored by the Archive's ilist, the Archive's main abstraction. Because of
  40 /// the special requirements of archive files, users are not permitted to
  41 /// construct ArchiveMember instances. You should obtain them from the methods
  42 /// of the Archive class instead.
  43 /// @brief This class represents a single archive member.
  44 class ArchiveMember : public ilist_node<ArchiveMember> {
  45   /// @name Types
  46   /// @{
  47   public:
  48     /// These flags are used internally by the archive member to specify various
  49     /// characteristics of the member. The various "is" methods below provide
  50     /// access to the flags. The flags are not user settable.
  51     enum Flags {
  52       SVR4SymbolTableFlag = 1,     ///< Member is a SVR4 symbol table
  53       BSD4SymbolTableFlag = 2,     ///< Member is a BSD4 symbol table
  54       BitcodeFlag         = 4,     ///< Member is bitcode
  55       HasLongFilenameFlag = 8,     ///< Member uses the long filename syntax
  56       StringTableFlag     = 16     ///< Member is an ar(1) format string table
  57     };
  58
  59   /// @}
  60   /// @name Accessors
  61   /// @{
  62   public:
  63     /// @returns the parent Archive instance
  64     /// @brief Get the archive associated with this member
  65     Archive* getArchive() const          { return parent; }
  66
  67     /// @returns the path to the Archive's file
  68     /// @brief Get the path to the archive member
  69     StringRef getPath() const     { return path; }
  70
  71     /// The "user" is the owner of the file per Unix security. This may not
  72     /// have any applicability on non-Unix systems but is a required component
  73     /// of the "ar" file format.
  74     /// @brief Get the user associated with this archive member.
  75     unsigned getUser() const             { return User; }
  76
  77     /// The "group" is the owning group of the file per Unix security. This
  78     /// may not have any applicability on non-Unix systems but is a required
  79     /// component of the "ar" file format.
  80     /// @brief Get the group associated with this archive member.
  81     unsigned getGroup() const            { return Group; }
  82
  83     /// The "mode" specifies the access permissions for the file per Unix
  84     /// security. This may not have any applicability on non-Unix systems but is
  85     /// a required component of the "ar" file format.
  86     /// @brief Get the permission mode associated with this archive member.
  87     unsigned getMode() const             { return Mode; }
  88
  89     /// This method returns the time at which the archive member was last
  90     /// modified when it was not in the archive.
  91     /// @brief Get the time of last modification of the archive member.
  92     sys::TimeValue getModTime() const    { return ModTime; }
  93
  94     /// @returns the size of the archive member in bytes.
  95     /// @brief Get the size of the archive member.
  96     uint64_t getSize() const             { return Size; }
  97
  98     /// This method returns the total size of the archive member as it
  99     /// appears on disk. This includes the file content, the header, the
 100     /// long file name if any, and the padding.
 101     /// @brief Get total on-disk member size.
 102     unsigned getMemberSize() const;
 103
 104     /// This method will return a pointer to the in-memory content of the
 105     /// archive member, if it is available. If the data has not been loaded
 106     /// into memory, the return value will be null.
 107     /// @returns a pointer to the member's data.
 108     /// @brief Get the data content of the archive member
 109     const char* getData() const { return data; }
 110
 111     /// @returns true iff the member is a SVR4 (non-LLVM) symbol table
 112     /// @brief Determine if this member is a SVR4 symbol table.
 113     bool isSVR4SymbolTable() const { return flags&SVR4SymbolTableFlag; }
 114
 115     /// @returns true iff the member is a BSD4.4 (non-LLVM) symbol table
 116     /// @brief Determine if this member is a BSD4.4 symbol table.
 117     bool isBSD4SymbolTable() const { return flags&BSD4SymbolTableFlag; }
 118
 119     /// @returns true iff the archive member is the ar(1) string table
 120     /// @brief Determine if this member is the ar(1) string table.
 121     bool isStringTable() const { return flags&StringTableFlag; }
 122
 123     /// @returns true iff the archive member is a bitcode file.
 124     /// @brief Determine if this member is a bitcode file.
 125     bool isBitcode() const { return flags&BitcodeFlag; }
 126
 127     /// Long filenames are an artifact of the ar(1) file format which allows
 128     /// up to sixteen characters in its header and doesn't allow a path
 129     /// separator character (/). To avoid this, a "long format" member name is
 130     /// allowed that doesn't have this restriction. This method determines if
 131     /// that "long format" is used for this member.
 132     /// @returns true iff the file name uses the long form
 133     /// @brief Determine if the member has a long file name
 134     bool hasLongFilename() const { return flags&HasLongFilenameFlag; }
 135
 136     /// This method causes the archive member to be replaced with the contents
 137     /// of the file specified by \p File. The contents of \p this will be
 138     /// updated to reflect the new data from \p File. The \p File must exist and
 139     /// be readable on entry to this method.
 140     /// @returns true if an error occurred, false otherwise
 141     /// @brief Replace contents of archive member with a new file.
 142     bool replaceWith(StringRef aFile, std::string* ErrMsg);
 143
 144   /// @}
 145   /// @name Data
 146   /// @{
 147   private:
 148     Archive *parent;  ///< Pointer to parent archive
 149     std::string path; ///< Path of file containing the member
 150     uint32_t User;
 151     uint32_t Group;
 152     uint32_t Mode;
 153     sys::TimeValue ModTime;
 154     uint64_t Size;
 155     unsigned flags;   ///< Flags about the archive member
 156     const char *data; ///< Data for the member
 157
 158   /// @}
 159   /// @name Constructors
 160   /// @{
 161   public:
 162     /// The default constructor is only used by the Archive's iplist when it
 163     /// constructs the list's sentry node.
 164     ArchiveMember();
 165
 166   private:
 167     /// Used internally by the Archive class to construct an ArchiveMember.
 168     /// The contents of the ArchiveMember are filled out by the Archive class.
 169     explicit ArchiveMember(Archive *PAR);
 170
 171     // So Archive can construct an ArchiveMember
 172     friend class llvm::Archive;
 173   /// @}
 174 };
 175
 176 /// This class defines the interface to LLVM Archive files. The Archive class
 177 /// presents the archive file as an ilist of ArchiveMember objects. The members
 178 /// can be rearranged in any fashion either by directly editing the ilist or by
 179 /// using editing methods on the Archive class (recommended). The Archive
 180 /// class also provides several ways of accessing the archive file for various
 181 /// purposes such as editing and linking.  Full symbol table support is provided
 182 /// for loading only those files that resolve symbols. Note that read
 183 /// performance of this library is _crucial_ for performance of JIT type
 184 /// applications and the linkers. Consequently, the implementation of the class
 185 /// is optimized for reading.
 186 class Archive {
 187
 188   /// @name Types
 189   /// @{
 190   public:
 191     /// This is the ilist type over which users may iterate to examine
 192     /// the contents of the archive
 193     /// @brief The ilist type of ArchiveMembers that Archive contains.
 194     typedef iplist<ArchiveMember> MembersList;
 195
 196     /// @brief Forward mutable iterator over ArchiveMember
 197     typedef MembersList::iterator iterator;
 198
 199     /// @brief Forward immutable iterator over ArchiveMember
 200     typedef MembersList::const_iterator const_iterator;
 201
 202     /// @brief Reverse mutable iterator over ArchiveMember
 203     typedef std::reverse_iterator<iterator> reverse_iterator;
 204
 205     /// @brief Reverse immutable iterator over ArchiveMember
 206     typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
 207
 208     /// @brief The in-memory version of the symbol table
 209     typedef std::map<std::string,unsigned> SymTabType;
 210
 211   /// @}
 212   /// @name ilist accessor methods
 213   /// @{
 214   public:
 215     inline iterator               begin()        { return members.begin();  }
 216     inline const_iterator         begin()  const { return members.begin();  }
 217     inline iterator               end  ()        { return members.end();    }
 218     inline const_iterator         end  ()  const { return members.end();    }
 219
 220     inline reverse_iterator       rbegin()       { return members.rbegin(); }
 221     inline const_reverse_iterator rbegin() const { return members.rbegin(); }
 222     inline reverse_iterator       rend  ()       { return members.rend();   }
 223     inline const_reverse_iterator rend  () const { return members.rend();   }
 224
 225     inline size_t                 size()   const { return members.size();   }
 226     inline bool                   empty()  const { return members.empty();  }
 227     inline const ArchiveMember&   front()  const { return members.front();  }
 228     inline       ArchiveMember&   front()        { return members.front();  }
 229     inline const ArchiveMember&   back()   const { return members.back();   }
 230     inline       ArchiveMember&   back()         { return members.back();   }
 231
 232   /// @}
 233   /// @name ilist mutator methods
 234   /// @{
 235   public:
 236     /// This method splices a \p src member from an archive (possibly \p this),
 237     /// to a position just before the member given by \p dest in \p this. When
 238     /// the archive is written, \p src will be written in its new location.
 239     /// @brief Move a member to a new location
 240     inline void splice(iterator dest, Archive& arch, iterator src)
 241       { return members.splice(dest,arch.members,src); }
 242
 243     /// This method erases a \p target member from the archive. When the
 244     /// archive is written, it will no longer contain \p target. The associated
 245     /// ArchiveMember is deleted.
 246     /// @brief Erase a member.
 247     inline iterator erase(iterator target) { return members.erase(target); }
 248
 249   /// @}
 250   /// @name Constructors
 251   /// @{
 252   public:
 253     /// Create an empty archive file and associate it with the \p Filename. This
 254     /// method does not actually create the archive disk file. It creates an
 255     /// empty Archive object. If the writeToDisk method is called, the archive
 256     /// file \p Filename will be created at that point, with whatever content
 257     /// the returned Archive object has at that time.
 258     /// @returns An Archive* that represents the new archive file.
 259     /// @brief Create an empty Archive.
 260     static Archive *CreateEmpty(
 261         StringRef Filename, ///< Name of the archive to (eventually) create.
 262         LLVMContext &C      ///< Context to use for global information
 263         );
 264
 265     /// Open an existing archive and load its contents in preparation for
 266     /// editing. After this call, the member ilist is completely populated based
 267     /// on the contents of the archive file. You should use this form of open if
 268     /// you intend to modify the archive or traverse its contents (e.g. for
 269     /// printing).
 270     /// @brief Open and load an archive file
 271     static Archive *OpenAndLoad(
 272         StringRef filePath,       ///< The file path to open and load
 273         LLVMContext &C,           ///< The context to use for global information
 274         std::string *ErrorMessage ///< An optional error string
 275         );
 276
 277     /// This destructor cleans up the Archive object, releases all memory, and
 278     /// closes files. It does nothing with the archive file on disk. If you
 279     /// haven't used the writeToDisk method by the time the destructor is
 280     /// called, all changes to the archive will be lost.
 281     /// @brief Destruct in-memory archive
 282     ~Archive();
 283
 284   /// @}
 285   /// @name Accessors
 286   /// @{
 287   public:
 288     /// @returns the path to the archive file.
 289     /// @brief Get the archive path.
 290     StringRef getPath() { return archPath; }
 291
 292     /// This method is provided so that editing methods can be invoked directly
 293     /// on the Archive's iplist of ArchiveMember. However, it is recommended
 294     /// that the usual STL style iterator interface be used instead.
 295     /// @returns the iplist of ArchiveMember
 296     /// @brief Get the iplist of the members
 297     MembersList& getMembers() { return members; }
 298
 299     /// This method returns the offset in the archive file to the first "real"
 300     /// file member. Archive files, on disk, have a signature and might have a
 301     /// symbol table that precedes the first actual file member. This method
 302     /// allows you to determine what the size of those fields are.
 303     /// @returns the offset to the first "real" file member  in the archive.
 304     /// @brief Get the offset to the first "real" file member  in the archive.
 305     unsigned getFirstFileOffset() { return firstFileOffset; }
 306
 307   /// @}
 308   /// @name Mutators
 309   /// @{
 310   public:
 311     /// This method is the only way to get the archive written to disk. It
 312     /// creates or overwrites the file specified when \p this was created
 313     /// or opened. The arguments provide options for writing the archive. If
 314     /// \p CreateSymbolTable is true, the archive is scanned for bitcode files
 315     /// and a symbol table of the externally visible function and global
 316     /// variable names is created. If \p TruncateNames is true, the names of the
 317     /// archive members will have their path component stripped and the file
 318     /// name will be truncated at 15 characters. If \p Compress is specified,
 319     /// all archive members will be compressed before being written. If
 320     /// \p PrintSymTab is true, the symbol table will be printed to std::cout.
 321     /// @returns true if an error occurred, \p error set to error message;
 322     /// returns false if the writing succeeded.
 323     /// @brief Write (possibly modified) archive contents to disk
 324     bool writeToDisk(
 325       bool TruncateNames=false,       ///< Truncate the filename to 15 chars
 326       std::string* ErrMessage=0       ///< If non-null, where error msg is set
 327     );
 328
 329     /// This method adds a new file to the archive. The \p filename is examined
 330     /// to determine just enough information to create an ArchiveMember object
 331     /// which is then inserted into the Archive object's ilist at the location
 332     /// given by \p where.
 333     /// @returns true if an error occurred, false otherwise
 334     /// @brief Add a file to the archive.
 335     bool addFileBefore(StringRef filename, ///< The file to be added
 336                        iterator where,     ///< Insertion point
 337                        std::string *ErrMsg ///< Optional error message location
 338                        );
 339
 340   /// @}
 341   /// @name Implementation
 342   /// @{
 343   protected:
 344     /// @brief Construct an Archive for \p filename and optionally  map it
 345     /// into memory.
 346     explicit Archive(StringRef filename, LLVMContext& C);
 347
 348     /// @returns A fully populated ArchiveMember or 0 if an error occurred.
 349     /// @brief Parse the header of a member starting at \p At
 350     ArchiveMember* parseMemberHeader(
 351       const char*&At,    ///< The pointer to the location we're parsing
 352       const char*End,    ///< The pointer to the end of the archive
 353       std::string* error ///< Optional error message catcher
 354     );
 355
 356     /// @param ErrMessage Set to address of a std::string to get error messages
 357     /// @returns false on error
 358     /// @brief Check that the archive signature is correct
 359     bool checkSignature(std::string* ErrMessage);
 360
 361     /// @param ErrMessage Set to address of a std::string to get error messages
 362     /// @returns false on error
 363     /// @brief Load the entire archive.
 364     bool loadArchive(std::string* ErrMessage);
 365
 366     /// @param ErrMessage Set to address of a std::string to get error messages
 367     /// @returns false on error
 368     /// @brief Load just the symbol table.
 369     bool loadSymbolTable(std::string* ErrMessage);
 370
 371     /// Writes one ArchiveMember to an ofstream. If an error occurs, returns
 372     /// false, otherwise true. If an error occurs and error is non-null then
 373     /// it will be set to an error message.
 374     /// @returns false if writing member succeeded,
 375     /// returns true if writing member failed, \p error set to error message.
 376     bool writeMember(
 377       const ArchiveMember& member, ///< The member to be written
 378       std::ofstream& ARFile,       ///< The file to write member onto
 379       bool TruncateNames,          ///< Should names be truncated to 11 chars?
 380       std::string* ErrMessage      ///< If non-null, place were error msg is set
 381     );
 382
 383     /// @brief Fill in an ArchiveMemberHeader from ArchiveMember.
 384     bool fillHeader(const ArchiveMember&mbr,
 385                     ArchiveMemberHeader& hdr,int sz, bool TruncateNames) const;
 386
 387     /// @brief Maps archive into memory
 388     bool mapToMemory(std::string* ErrMsg);
 389
 390     /// @brief Frees all the members and unmaps the archive file.
 391     void cleanUpMemory();
 392
 393     /// This type is used to keep track of bitcode modules loaded from the
 394     /// symbol table. It maps the file offset to a pair that consists of the
 395     /// associated ArchiveMember and the Module.
 396     /// @brief Module mapping type
 397     typedef std::map<unsigned,std::pair<Module*,ArchiveMember*> >
 398       ModuleMap;
 399
 400
 401   /// @}
 402   /// @name Data
 403   /// @{
 404   protected:
 405     std::string archPath;     ///< Path to the archive file we read/write
 406     MembersList members;      ///< The ilist of ArchiveMember
 407     MemoryBuffer *mapfile;    ///< Raw Archive contents mapped into memory
 408     const char* base;         ///< Base of the memory mapped file data
 409     std::string strtab;       ///< The string table for long file names
 410     unsigned firstFileOffset; ///< Offset to first normal file.
 411     ModuleMap modules;        ///< The modules loaded via symbol lookup.
 412     LLVMContext& Context;     ///< This holds global data.
 413   /// @}
 414   /// @name Hidden
 415   /// @{
 416   private:
 417     Archive() LLVM_DELETED_FUNCTION;
 418     Archive(const Archive&) LLVM_DELETED_FUNCTION;
 419     Archive& operator=(const Archive&) LLVM_DELETED_FUNCTION;
 420   /// @}
 421 };
 422
 423 } // End llvm namespace
 424
 425 #endif