1224133Sdim//===- Binary.h - A generic binary file -------------------------*- C++ -*-===// 2224133Sdim// 3353358Sdim// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4353358Sdim// See https://llvm.org/LICENSE.txt for license information. 5353358Sdim// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6224133Sdim// 7224133Sdim//===----------------------------------------------------------------------===// 8224133Sdim// 9224133Sdim// This file declares the Binary class. 10224133Sdim// 11224133Sdim//===----------------------------------------------------------------------===// 12224133Sdim 13224133Sdim#ifndef LLVM_OBJECT_BINARY_H 14224133Sdim#define LLVM_OBJECT_BINARY_H 15224133Sdim 16353358Sdim#include "llvm-c/Types.h" 17321369Sdim#include "llvm/ADT/Triple.h" 18327952Sdim#include "llvm/Object/Error.h" 19321369Sdim#include "llvm/Support/Error.h" 20280031Sdim#include "llvm/Support/MemoryBuffer.h" 21321369Sdim#include <algorithm> 22321369Sdim#include <memory> 23321369Sdim#include <utility> 24224133Sdim 25224133Sdimnamespace llvm { 26224133Sdim 27276479Sdimclass LLVMContext; 28224133Sdimclass StringRef; 29224133Sdim 30224133Sdimnamespace object { 31224133Sdim 32224133Sdimclass Binary { 33224133Sdimprivate: 34224133Sdim unsigned int TypeID; 35224133Sdim 36224133Sdimprotected: 37280031Sdim MemoryBufferRef Data; 38224133Sdim 39280031Sdim Binary(unsigned int Type, MemoryBufferRef Source); 40224133Sdim 41224133Sdim enum { 42234353Sdim ID_Archive, 43261991Sdim ID_MachOUniversalBinary, 44296417Sdim ID_COFFImportFile, 45360784Sdim ID_IR, // LLVM IR 46360784Sdim ID_TapiUniversal, // Text-based Dynamic Library Stub file. 47360784Sdim ID_TapiFile, // Text-based Dynamic Library Stub file. 48276479Sdim 49353358Sdim ID_Minidump, 50353358Sdim 51327952Sdim ID_WinRes, // Windows resource (.res) file. 52327952Sdim 53224133Sdim // Object and children. 54234353Sdim ID_StartObjects, 55234353Sdim ID_COFF, 56251662Sdim 57353358Sdim ID_XCOFF32, // AIX XCOFF 32-bit 58353358Sdim ID_XCOFF64, // AIX XCOFF 64-bit 59353358Sdim 60234353Sdim ID_ELF32L, // ELF 32-bit, little endian 61234353Sdim ID_ELF32B, // ELF 32-bit, big endian 62234353Sdim ID_ELF64L, // ELF 64-bit, little endian 63234353Sdim ID_ELF64B, // ELF 64-bit, big endian 64251662Sdim 65251662Sdim ID_MachO32L, // MachO 32-bit, little endian 66251662Sdim ID_MachO32B, // MachO 32-bit, big endian 67251662Sdim ID_MachO64L, // MachO 64-bit, little endian 68251662Sdim ID_MachO64B, // MachO 64-bit, big endian 69251662Sdim 70314564Sdim ID_Wasm, 71314564Sdim 72234353Sdim ID_EndObjects 73224133Sdim }; 74224133Sdim 75249423Sdim static inline unsigned int getELFType(bool isLE, bool is64Bits) { 76249423Sdim if (isLE) 77234353Sdim return is64Bits ? ID_ELF64L : ID_ELF32L; 78234353Sdim else 79234353Sdim return is64Bits ? ID_ELF64B : ID_ELF32B; 80234353Sdim } 81234353Sdim 82251662Sdim static unsigned int getMachOType(bool isLE, bool is64Bits) { 83251662Sdim if (isLE) 84251662Sdim return is64Bits ? ID_MachO64L : ID_MachO32L; 85251662Sdim else 86251662Sdim return is64Bits ? ID_MachO64B : ID_MachO32B; 87251662Sdim } 88251662Sdim 89224133Sdimpublic: 90321369Sdim Binary() = delete; 91321369Sdim Binary(const Binary &other) = delete; 92224133Sdim virtual ~Binary(); 93224133Sdim 94224133Sdim StringRef getData() const; 95224133Sdim StringRef getFileName() const; 96280031Sdim MemoryBufferRef getMemoryBufferRef() const; 97224133Sdim 98224133Sdim // Cast methods. 99224133Sdim unsigned int getType() const { return TypeID; } 100234353Sdim 101234353Sdim // Convenience methods 102234353Sdim bool isObject() const { 103234353Sdim return TypeID > ID_StartObjects && TypeID < ID_EndObjects; 104234353Sdim } 105234353Sdim 106360784Sdim bool isSymbolic() const { 107360784Sdim return isIR() || isObject() || isCOFFImportFile() || isTapiFile(); 108234353Sdim } 109234353Sdim 110360784Sdim bool isArchive() const { return TypeID == ID_Archive; } 111360784Sdim 112261991Sdim bool isMachOUniversalBinary() const { 113261991Sdim return TypeID == ID_MachOUniversalBinary; 114261991Sdim } 115261991Sdim 116360784Sdim bool isTapiUniversal() const { return TypeID == ID_TapiUniversal; } 117360784Sdim 118234353Sdim bool isELF() const { 119234353Sdim return TypeID >= ID_ELF32L && TypeID <= ID_ELF64B; 120234353Sdim } 121234353Sdim 122234353Sdim bool isMachO() const { 123251662Sdim return TypeID >= ID_MachO32L && TypeID <= ID_MachO64B; 124234353Sdim } 125234353Sdim 126234353Sdim bool isCOFF() const { 127234353Sdim return TypeID == ID_COFF; 128234353Sdim } 129249423Sdim 130353358Sdim bool isXCOFF() const { return TypeID == ID_XCOFF32 || TypeID == ID_XCOFF64; } 131353358Sdim 132314564Sdim bool isWasm() const { return TypeID == ID_Wasm; } 133314564Sdim 134296417Sdim bool isCOFFImportFile() const { 135296417Sdim return TypeID == ID_COFFImportFile; 136296417Sdim } 137296417Sdim 138276479Sdim bool isIR() const { 139276479Sdim return TypeID == ID_IR; 140276479Sdim } 141276479Sdim 142353358Sdim bool isMinidump() const { return TypeID == ID_Minidump; } 143353358Sdim 144360784Sdim bool isTapiFile() const { return TypeID == ID_TapiFile; } 145360784Sdim 146249423Sdim bool isLittleEndian() const { 147251662Sdim return !(TypeID == ID_ELF32B || TypeID == ID_ELF64B || 148251662Sdim TypeID == ID_MachO32B || TypeID == ID_MachO64B); 149249423Sdim } 150321369Sdim 151321369Sdim bool isWinRes() const { return TypeID == ID_WinRes; } 152321369Sdim 153321369Sdim Triple::ObjectFormatType getTripleObjectFormat() const { 154321369Sdim if (isCOFF()) 155321369Sdim return Triple::COFF; 156321369Sdim if (isMachO()) 157321369Sdim return Triple::MachO; 158321369Sdim if (isELF()) 159321369Sdim return Triple::ELF; 160321369Sdim return Triple::UnknownObjectFormat; 161321369Sdim } 162327952Sdim 163327952Sdim static std::error_code checkOffset(MemoryBufferRef M, uintptr_t Addr, 164327952Sdim const uint64_t Size) { 165327952Sdim if (Addr + Size < Addr || Addr + Size < Size || 166327952Sdim Addr + Size > uintptr_t(M.getBufferEnd()) || 167327952Sdim Addr < uintptr_t(M.getBufferStart())) { 168327952Sdim return object_error::unexpected_eof; 169327952Sdim } 170327952Sdim return std::error_code(); 171327952Sdim } 172224133Sdim}; 173224133Sdim 174353358Sdim// Create wrappers for C Binding types (see CBindingWrapping.h). 175353358SdimDEFINE_ISA_CONVERSION_FUNCTIONS(Binary, LLVMBinaryRef) 176353358Sdim 177341825Sdim/// Create a Binary from Source, autodetecting the file type. 178234353Sdim/// 179276479Sdim/// @param Source The data to create the Binary from. 180309124SdimExpected<std::unique_ptr<Binary>> createBinary(MemoryBufferRef Source, 181309124Sdim LLVMContext *Context = nullptr); 182234353Sdim 183280031Sdimtemplate <typename T> class OwningBinary { 184280031Sdim std::unique_ptr<T> Bin; 185280031Sdim std::unique_ptr<MemoryBuffer> Buf; 186280031Sdim 187280031Sdimpublic: 188280031Sdim OwningBinary(); 189280031Sdim OwningBinary(std::unique_ptr<T> Bin, std::unique_ptr<MemoryBuffer> Buf); 190280031Sdim OwningBinary(OwningBinary<T>&& Other); 191280031Sdim OwningBinary<T> &operator=(OwningBinary<T> &&Other); 192280031Sdim 193280031Sdim std::pair<std::unique_ptr<T>, std::unique_ptr<MemoryBuffer>> takeBinary(); 194280031Sdim 195280031Sdim T* getBinary(); 196280031Sdim const T* getBinary() const; 197280031Sdim}; 198280031Sdim 199280031Sdimtemplate <typename T> 200280031SdimOwningBinary<T>::OwningBinary(std::unique_ptr<T> Bin, 201280031Sdim std::unique_ptr<MemoryBuffer> Buf) 202280031Sdim : Bin(std::move(Bin)), Buf(std::move(Buf)) {} 203280031Sdim 204321369Sdimtemplate <typename T> OwningBinary<T>::OwningBinary() = default; 205280031Sdim 206280031Sdimtemplate <typename T> 207280031SdimOwningBinary<T>::OwningBinary(OwningBinary &&Other) 208280031Sdim : Bin(std::move(Other.Bin)), Buf(std::move(Other.Buf)) {} 209280031Sdim 210280031Sdimtemplate <typename T> 211280031SdimOwningBinary<T> &OwningBinary<T>::operator=(OwningBinary &&Other) { 212280031Sdim Bin = std::move(Other.Bin); 213280031Sdim Buf = std::move(Other.Buf); 214280031Sdim return *this; 215224133Sdim} 216280031Sdim 217280031Sdimtemplate <typename T> 218280031Sdimstd::pair<std::unique_ptr<T>, std::unique_ptr<MemoryBuffer>> 219280031SdimOwningBinary<T>::takeBinary() { 220280031Sdim return std::make_pair(std::move(Bin), std::move(Buf)); 221224133Sdim} 222224133Sdim 223280031Sdimtemplate <typename T> T* OwningBinary<T>::getBinary() { 224280031Sdim return Bin.get(); 225280031Sdim} 226280031Sdim 227280031Sdimtemplate <typename T> const T* OwningBinary<T>::getBinary() const { 228280031Sdim return Bin.get(); 229280031Sdim} 230280031Sdim 231309124SdimExpected<OwningBinary<Binary>> createBinary(StringRef Path); 232280031Sdim 233321369Sdim} // end namespace object 234321369Sdim 235321369Sdim} // end namespace llvm 236321369Sdim 237321369Sdim#endif // LLVM_OBJECT_BINARY_H 238