include/llvm/Object/Binary.h

   1 //===- Binary.h - A generic binary file -------------------------*- 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 declares the Binary class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_OBJECT_BINARY_H
  15 #define LLVM_OBJECT_BINARY_H
  16
  17 #include "llvm/Object/Error.h"
  18 #include "llvm/Support/ErrorOr.h"
  19 #include "llvm/Support/FileSystem.h"
  20
  21 namespace llvm {
  22
  23 class LLVMContext;
  24 class MemoryBuffer;
  25 class StringRef;
  26
  27 namespace object {
  28
  29 class Binary {
  30 private:
  31   Binary() LLVM_DELETED_FUNCTION;
  32   Binary(const Binary &other) LLVM_DELETED_FUNCTION;
  33
  34   unsigned int TypeID;
  35   bool BufferOwned;
  36
  37 protected:
  38   MemoryBuffer *Data;
  39
  40   Binary(unsigned int Type, MemoryBuffer *Source, bool BufferOwned = true);
  41
  42   enum {
  43     ID_Archive,
  44     ID_MachOUniversalBinary,
  45     ID_IR, // LLVM IR
  46
  47     // Object and children.
  48     ID_StartObjects,
  49     ID_COFF,
  50
  51     ID_ELF32L, // ELF 32-bit, little endian
  52     ID_ELF32B, // ELF 32-bit, big endian
  53     ID_ELF64L, // ELF 64-bit, little endian
  54     ID_ELF64B, // ELF 64-bit, big endian
  55
  56     ID_MachO32L, // MachO 32-bit, little endian
  57     ID_MachO32B, // MachO 32-bit, big endian
  58     ID_MachO64L, // MachO 64-bit, little endian
  59     ID_MachO64B, // MachO 64-bit, big endian
  60
  61     ID_EndObjects
  62   };
  63
  64   static inline unsigned int getELFType(bool isLE, bool is64Bits) {
  65     if (isLE)
  66       return is64Bits ? ID_ELF64L : ID_ELF32L;
  67     else
  68       return is64Bits ? ID_ELF64B : ID_ELF32B;
  69   }
  70
  71   static unsigned int getMachOType(bool isLE, bool is64Bits) {
  72     if (isLE)
  73       return is64Bits ? ID_MachO64L : ID_MachO32L;
  74     else
  75       return is64Bits ? ID_MachO64B : ID_MachO32B;
  76   }
  77
  78 public:
  79   virtual ~Binary();
  80
  81   StringRef getData() const;
  82   StringRef getFileName() const;
  83
  84   // Cast methods.
  85   unsigned int getType() const { return TypeID; }
  86
  87   // Convenience methods
  88   bool isObject() const {
  89     return TypeID > ID_StartObjects && TypeID < ID_EndObjects;
  90   }
  91
  92   bool isSymbolic() const {
  93     return isIR() || isObject();
  94   }
  95
  96   bool isArchive() const {
  97     return TypeID == ID_Archive;
  98   }
  99
 100   bool isMachOUniversalBinary() const {
 101     return TypeID == ID_MachOUniversalBinary;
 102   }
 103
 104   bool isELF() const {
 105     return TypeID >= ID_ELF32L && TypeID <= ID_ELF64B;
 106   }
 107
 108   bool isMachO() const {
 109     return TypeID >= ID_MachO32L && TypeID <= ID_MachO64B;
 110   }
 111
 112   bool isCOFF() const {
 113     return TypeID == ID_COFF;
 114   }
 115
 116   bool isIR() const {
 117     return TypeID == ID_IR;
 118   }
 119
 120   bool isLittleEndian() const {
 121     return !(TypeID == ID_ELF32B || TypeID == ID_ELF64B ||
 122              TypeID == ID_MachO32B || TypeID == ID_MachO64B);
 123   }
 124 };
 125
 126 /// @brief Create a Binary from Source, autodetecting the file type.
 127 ///
 128 /// @param Source The data to create the Binary from. Ownership is transferred
 129 ///        to the Binary if successful. If an error is returned,
 130 ///        Source is destroyed by createBinary before returning.
 131 ErrorOr<Binary *> createBinary(MemoryBuffer *Source,
 132                                LLVMContext *Context = nullptr);
 133
 134 ErrorOr<Binary *> createBinary(StringRef Path);
 135 }
 136 }
 137
 138 #endif