diff --git a/llvm/include/llvm-c/Object.h b/llvm/include/llvm-c/Object.h index a32f6514094d..1e9b703a68ff 100644 --- a/llvm/include/llvm-c/Object.h +++ b/llvm/include/llvm-c/Object.h @@ -1,217 +1,233 @@ /*===-- llvm-c/Object.h - Object Lib C Iface --------------------*- C++ -*-===*/ /* */ /* Part of the LLVM Project, under the Apache License v2.0 with LLVM */ /* Exceptions. */ /* See https://llvm.org/LICENSE.txt for license information. */ /* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception */ /* */ /*===----------------------------------------------------------------------===*/ /* */ /* This header declares the C interface to libLLVMObject.a, which */ /* implements object file reading and writing. */ /* */ /* Many exotic languages can interoperate with C code but have a harder time */ /* with C++ due to name mangling. So in addition to C, this interface enables */ /* tools written in such languages. */ /* */ /*===----------------------------------------------------------------------===*/ #ifndef LLVM_C_OBJECT_H #define LLVM_C_OBJECT_H #include "llvm-c/Types.h" #include "llvm/Config/llvm-config.h" #ifdef __cplusplus extern "C" { #endif /** * @defgroup LLVMCObject Object file reading and writing * @ingroup LLVMC * * @{ */ // Opaque type wrappers typedef struct LLVMOpaqueSectionIterator *LLVMSectionIteratorRef; typedef struct LLVMOpaqueSymbolIterator *LLVMSymbolIteratorRef; typedef struct LLVMOpaqueRelocationIterator *LLVMRelocationIteratorRef; typedef enum { LLVMBinaryTypeArchive, /**< Archive file. */ LLVMBinaryTypeMachOUniversalBinary, /**< Mach-O Universal Binary file. */ LLVMBinaryTypeCOFFImportFile, /**< COFF Import file. */ LLVMBinaryTypeIR, /**< LLVM IR. */ LLVMBinaryTypeWinRes, /**< Windows resource (.res) file. */ LLVMBinaryTypeCOFF, /**< COFF Object file. */ LLVMBinaryTypeELF32L, /**< ELF 32-bit, little endian. */ LLVMBinaryTypeELF32B, /**< ELF 32-bit, big endian. */ LLVMBinaryTypeELF64L, /**< ELF 64-bit, little endian. */ LLVMBinaryTypeELF64B, /**< ELF 64-bit, big endian. */ LLVMBinaryTypeMachO32L, /**< MachO 32-bit, little endian. */ LLVMBinaryTypeMachO32B, /**< MachO 32-bit, big endian. */ LLVMBinaryTypeMachO64L, /**< MachO 64-bit, little endian. */ LLVMBinaryTypeMachO64B, /**< MachO 64-bit, big endian. */ LLVMBinaryTypeWasm, /**< Web Assembly. */ } LLVMBinaryType; /** * Create a binary file from the given memory buffer. * * The exact type of the binary file will be inferred automatically, and the * appropriate implementation selected. The context may be NULL except if * the resulting file is an LLVM IR file. * * The memory buffer is not consumed by this function. It is the responsibilty * of the caller to free it with \c LLVMDisposeMemoryBuffer. * * If NULL is returned, the \p ErrorMessage parameter is populated with the * error's description. It is then the caller's responsibility to free this * message by calling \c LLVMDisposeMessage. * * @see llvm::object::createBinary */ LLVMBinaryRef LLVMCreateBinary(LLVMMemoryBufferRef MemBuf, LLVMContextRef Context, char **ErrorMessage); /** * Dispose of a binary file. * * The binary file does not own its backing buffer. It is the responsibilty * of the caller to free it with \c LLVMDisposeMemoryBuffer. */ void LLVMDisposeBinary(LLVMBinaryRef BR); /** * Retrieves a copy of the memory buffer associated with this object file. * * The returned buffer is merely a shallow copy and does not own the actual * backing buffer of the binary. Nevertheless, it is the responsibility of the * caller to free it with \c LLVMDisposeMemoryBuffer. * * @see llvm::object::getMemoryBufferRef */ LLVMMemoryBufferRef LLVMBinaryCopyMemoryBuffer(LLVMBinaryRef BR); /** * Retrieve the specific type of a binary. * * @see llvm::object::Binary::getType */ LLVMBinaryType LLVMBinaryGetType(LLVMBinaryRef BR); +/* + * For a Mach-O universal binary file, retrieves the object file corresponding + * to the given architecture if it is present as a slice. + * + * If NULL is returned, the \p ErrorMessage parameter is populated with the + * error's description. It is then the caller's responsibility to free this + * message by calling \c LLVMDisposeMessage. + * + * It is the responsiblity of the caller to free the returned object file by + * calling \c LLVMDisposeBinary. + */ +LLVMBinaryRef LLVMMachOUniversalBinaryCopyObjectForArch(LLVMBinaryRef BR, + const char *Arch, + size_t ArchLen, + char **ErrorMessage); + /** * Retrieve a copy of the section iterator for this object file. * * If there are no sections, the result is NULL. * * The returned iterator is merely a shallow copy. Nevertheless, it is * the responsibility of the caller to free it with * \c LLVMDisposeSectionIterator. * * @see llvm::object::sections() */ LLVMSectionIteratorRef LLVMObjectFileCopySectionIterator(LLVMBinaryRef BR); /** * Returns whether the given section iterator is at the end. * * @see llvm::object::section_end */ LLVMBool LLVMObjectFileIsSectionIteratorAtEnd(LLVMBinaryRef BR, LLVMSectionIteratorRef SI); /** * Retrieve a copy of the symbol iterator for this object file. * * If there are no symbols, the result is NULL. * * The returned iterator is merely a shallow copy. Nevertheless, it is * the responsibility of the caller to free it with * \c LLVMDisposeSymbolIterator. * * @see llvm::object::symbols() */ LLVMSymbolIteratorRef LLVMObjectFileCopySymbolIterator(LLVMBinaryRef BR); /** * Returns whether the given symbol iterator is at the end. * * @see llvm::object::symbol_end */ LLVMBool LLVMObjectFileIsSymbolIteratorAtEnd(LLVMBinaryRef BR, LLVMSymbolIteratorRef SI); void LLVMDisposeSectionIterator(LLVMSectionIteratorRef SI); void LLVMMoveToNextSection(LLVMSectionIteratorRef SI); void LLVMMoveToContainingSection(LLVMSectionIteratorRef Sect, LLVMSymbolIteratorRef Sym); // ObjectFile Symbol iterators void LLVMDisposeSymbolIterator(LLVMSymbolIteratorRef SI); void LLVMMoveToNextSymbol(LLVMSymbolIteratorRef SI); // SectionRef accessors const char *LLVMGetSectionName(LLVMSectionIteratorRef SI); uint64_t LLVMGetSectionSize(LLVMSectionIteratorRef SI); const char *LLVMGetSectionContents(LLVMSectionIteratorRef SI); uint64_t LLVMGetSectionAddress(LLVMSectionIteratorRef SI); LLVMBool LLVMGetSectionContainsSymbol(LLVMSectionIteratorRef SI, LLVMSymbolIteratorRef Sym); // Section Relocation iterators LLVMRelocationIteratorRef LLVMGetRelocations(LLVMSectionIteratorRef Section); void LLVMDisposeRelocationIterator(LLVMRelocationIteratorRef RI); LLVMBool LLVMIsRelocationIteratorAtEnd(LLVMSectionIteratorRef Section, LLVMRelocationIteratorRef RI); void LLVMMoveToNextRelocation(LLVMRelocationIteratorRef RI); // SymbolRef accessors const char *LLVMGetSymbolName(LLVMSymbolIteratorRef SI); uint64_t LLVMGetSymbolAddress(LLVMSymbolIteratorRef SI); uint64_t LLVMGetSymbolSize(LLVMSymbolIteratorRef SI); // RelocationRef accessors uint64_t LLVMGetRelocationOffset(LLVMRelocationIteratorRef RI); LLVMSymbolIteratorRef LLVMGetRelocationSymbol(LLVMRelocationIteratorRef RI); uint64_t LLVMGetRelocationType(LLVMRelocationIteratorRef RI); // NOTE: Caller takes ownership of returned string of the two // following functions. const char *LLVMGetRelocationTypeName(LLVMRelocationIteratorRef RI); const char *LLVMGetRelocationValueString(LLVMRelocationIteratorRef RI); /** Deprecated: Use LLVMBinaryRef instead. */ typedef struct LLVMOpaqueObjectFile *LLVMObjectFileRef; /** Deprecated: Use LLVMCreateBinary instead. */ LLVMObjectFileRef LLVMCreateObjectFile(LLVMMemoryBufferRef MemBuf); /** Deprecated: Use LLVMDisposeBinary instead. */ void LLVMDisposeObjectFile(LLVMObjectFileRef ObjectFile); /** Deprecated: Use LLVMObjectFileCopySectionIterator instead. */ LLVMSectionIteratorRef LLVMGetSections(LLVMObjectFileRef ObjectFile); /** Deprecated: Use LLVMObjectFileIsSectionIteratorAtEnd instead. */ LLVMBool LLVMIsSectionIteratorAtEnd(LLVMObjectFileRef ObjectFile, LLVMSectionIteratorRef SI); /** Deprecated: Use LLVMObjectFileCopySymbolIterator instead. */ LLVMSymbolIteratorRef LLVMGetSymbols(LLVMObjectFileRef ObjectFile); /** Deprecated: Use LLVMObjectFileIsSymbolIteratorAtEnd instead. */ LLVMBool LLVMIsSymbolIteratorAtEnd(LLVMObjectFileRef ObjectFile, LLVMSymbolIteratorRef SI); /** * @} */ #ifdef __cplusplus } #endif /* defined(__cplusplus) */ #endif diff --git a/llvm/lib/Object/Object.cpp b/llvm/lib/Object/Object.cpp index e2511b7aed03..d84798cc6dd0 100644 --- a/llvm/lib/Object/Object.cpp +++ b/llvm/lib/Object/Object.cpp @@ -1,341 +1,356 @@ //===- Object.cpp - C bindings to the object file library--------*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// // // This file defines the C bindings to the file-format-independent object // library. // //===----------------------------------------------------------------------===// #include "llvm-c/Object.h" #include "llvm/ADT/SmallVector.h" #include "llvm/IR/LLVMContext.h" #include "llvm/Object/ObjectFile.h" +#include "llvm/Object/MachOUniversal.h" using namespace llvm; using namespace object; inline OwningBinary *unwrap(LLVMObjectFileRef OF) { return reinterpret_cast *>(OF); } inline LLVMObjectFileRef wrap(const OwningBinary *OF) { return reinterpret_cast( const_cast *>(OF)); } inline section_iterator *unwrap(LLVMSectionIteratorRef SI) { return reinterpret_cast(SI); } inline LLVMSectionIteratorRef wrap(const section_iterator *SI) { return reinterpret_cast (const_cast(SI)); } inline symbol_iterator *unwrap(LLVMSymbolIteratorRef SI) { return reinterpret_cast(SI); } inline LLVMSymbolIteratorRef wrap(const symbol_iterator *SI) { return reinterpret_cast (const_cast(SI)); } inline relocation_iterator *unwrap(LLVMRelocationIteratorRef SI) { return reinterpret_cast(SI); } inline LLVMRelocationIteratorRef wrap(const relocation_iterator *SI) { return reinterpret_cast (const_cast(SI)); } /*--.. Operations on binary files ..........................................--*/ LLVMBinaryRef LLVMCreateBinary(LLVMMemoryBufferRef MemBuf, LLVMContextRef Context, char **ErrorMessage) { auto maybeContext = Context ? unwrap(Context) : nullptr; Expected> ObjOrErr( createBinary(unwrap(MemBuf)->getMemBufferRef(), maybeContext)); if (!ObjOrErr) { *ErrorMessage = strdup(toString(ObjOrErr.takeError()).c_str()); return nullptr; } return wrap(ObjOrErr.get().release()); } LLVMMemoryBufferRef LLVMBinaryCopyMemoryBuffer(LLVMBinaryRef BR) { auto Buf = unwrap(BR)->getMemoryBufferRef(); return wrap(llvm::MemoryBuffer::getMemBuffer( Buf.getBuffer(), Buf.getBufferIdentifier(), /*RequiresNullTerminator*/false).release()); } void LLVMDisposeBinary(LLVMBinaryRef BR) { delete unwrap(BR); } LLVMBinaryType LLVMBinaryGetType(LLVMBinaryRef BR) { class BinaryTypeMapper final : public Binary { public: static LLVMBinaryType mapBinaryTypeToLLVMBinaryType(unsigned Kind) { switch (Kind) { case ID_Archive: return LLVMBinaryTypeArchive; case ID_MachOUniversalBinary: return LLVMBinaryTypeMachOUniversalBinary; case ID_COFFImportFile: return LLVMBinaryTypeCOFFImportFile; case ID_IR: return LLVMBinaryTypeIR; case ID_WinRes: return LLVMBinaryTypeWinRes; case ID_COFF: return LLVMBinaryTypeCOFF; case ID_ELF32L: return LLVMBinaryTypeELF32L; case ID_ELF32B: return LLVMBinaryTypeELF32B; case ID_ELF64L: return LLVMBinaryTypeELF64L; case ID_ELF64B: return LLVMBinaryTypeELF64B; case ID_MachO32L: return LLVMBinaryTypeMachO32L; case ID_MachO32B: return LLVMBinaryTypeMachO32B; case ID_MachO64L: return LLVMBinaryTypeMachO64L; case ID_MachO64B: return LLVMBinaryTypeMachO64B; case ID_Wasm: return LLVMBinaryTypeWasm; case ID_StartObjects: case ID_EndObjects: llvm_unreachable("Marker types are not valid binary kinds!"); default: llvm_unreachable("Unknown binary kind!"); } } }; return BinaryTypeMapper::mapBinaryTypeToLLVMBinaryType(unwrap(BR)->getType()); } +LLVMBinaryRef LLVMMachOUniversalBinaryCopyObjectForArch(LLVMBinaryRef BR, + const char *Arch, + size_t ArchLen, + char **ErrorMessage) { + auto universal = cast(unwrap(BR)); + Expected> ObjOrErr( + universal->getObjectForArch({Arch, ArchLen})); + if (!ObjOrErr) { + *ErrorMessage = strdup(toString(ObjOrErr.takeError()).c_str()); + return nullptr; + } + return wrap(ObjOrErr.get().release()); +} + LLVMSectionIteratorRef LLVMObjectFileCopySectionIterator(LLVMBinaryRef BR) { auto OF = cast(unwrap(BR)); auto sections = OF->sections(); if (sections.begin() == sections.end()) return nullptr; return wrap(new section_iterator(sections.begin())); } LLVMBool LLVMObjectFileIsSectionIteratorAtEnd(LLVMBinaryRef BR, LLVMSectionIteratorRef SI) { auto OF = cast(unwrap(BR)); return (*unwrap(SI) == OF->section_end()) ? 1 : 0; } LLVMSymbolIteratorRef LLVMObjectFileCopySymbolIterator(LLVMBinaryRef BR) { auto OF = cast(unwrap(BR)); auto symbols = OF->symbols(); if (symbols.begin() == symbols.end()) return nullptr; return wrap(new symbol_iterator(symbols.begin())); } LLVMBool LLVMObjectFileIsSymbolIteratorAtEnd(LLVMBinaryRef BR, LLVMSymbolIteratorRef SI) { auto OF = cast(unwrap(BR)); return (*unwrap(SI) == OF->symbol_end()) ? 1 : 0; } // ObjectFile creation LLVMObjectFileRef LLVMCreateObjectFile(LLVMMemoryBufferRef MemBuf) { std::unique_ptr Buf(unwrap(MemBuf)); Expected> ObjOrErr( ObjectFile::createObjectFile(Buf->getMemBufferRef())); std::unique_ptr Obj; if (!ObjOrErr) { // TODO: Actually report errors helpfully. consumeError(ObjOrErr.takeError()); return nullptr; } auto *Ret = new OwningBinary(std::move(ObjOrErr.get()), std::move(Buf)); return wrap(Ret); } void LLVMDisposeObjectFile(LLVMObjectFileRef ObjectFile) { delete unwrap(ObjectFile); } // ObjectFile Section iterators LLVMSectionIteratorRef LLVMGetSections(LLVMObjectFileRef OF) { OwningBinary *OB = unwrap(OF); section_iterator SI = OB->getBinary()->section_begin(); return wrap(new section_iterator(SI)); } void LLVMDisposeSectionIterator(LLVMSectionIteratorRef SI) { delete unwrap(SI); } LLVMBool LLVMIsSectionIteratorAtEnd(LLVMObjectFileRef OF, LLVMSectionIteratorRef SI) { OwningBinary *OB = unwrap(OF); return (*unwrap(SI) == OB->getBinary()->section_end()) ? 1 : 0; } void LLVMMoveToNextSection(LLVMSectionIteratorRef SI) { ++(*unwrap(SI)); } void LLVMMoveToContainingSection(LLVMSectionIteratorRef Sect, LLVMSymbolIteratorRef Sym) { Expected SecOrErr = (*unwrap(Sym))->getSection(); if (!SecOrErr) { std::string Buf; raw_string_ostream OS(Buf); logAllUnhandledErrors(SecOrErr.takeError(), OS); OS.flush(); report_fatal_error(Buf); } *unwrap(Sect) = *SecOrErr; } // ObjectFile Symbol iterators LLVMSymbolIteratorRef LLVMGetSymbols(LLVMObjectFileRef OF) { OwningBinary *OB = unwrap(OF); symbol_iterator SI = OB->getBinary()->symbol_begin(); return wrap(new symbol_iterator(SI)); } void LLVMDisposeSymbolIterator(LLVMSymbolIteratorRef SI) { delete unwrap(SI); } LLVMBool LLVMIsSymbolIteratorAtEnd(LLVMObjectFileRef OF, LLVMSymbolIteratorRef SI) { OwningBinary *OB = unwrap(OF); return (*unwrap(SI) == OB->getBinary()->symbol_end()) ? 1 : 0; } void LLVMMoveToNextSymbol(LLVMSymbolIteratorRef SI) { ++(*unwrap(SI)); } // SectionRef accessors const char *LLVMGetSectionName(LLVMSectionIteratorRef SI) { StringRef ret; if (std::error_code ec = (*unwrap(SI))->getName(ret)) report_fatal_error(ec.message()); return ret.data(); } uint64_t LLVMGetSectionSize(LLVMSectionIteratorRef SI) { return (*unwrap(SI))->getSize(); } const char *LLVMGetSectionContents(LLVMSectionIteratorRef SI) { if (Expected E = (*unwrap(SI))->getContents()) return E->data(); else report_fatal_error(E.takeError()); } uint64_t LLVMGetSectionAddress(LLVMSectionIteratorRef SI) { return (*unwrap(SI))->getAddress(); } LLVMBool LLVMGetSectionContainsSymbol(LLVMSectionIteratorRef SI, LLVMSymbolIteratorRef Sym) { return (*unwrap(SI))->containsSymbol(**unwrap(Sym)); } // Section Relocation iterators LLVMRelocationIteratorRef LLVMGetRelocations(LLVMSectionIteratorRef Section) { relocation_iterator SI = (*unwrap(Section))->relocation_begin(); return wrap(new relocation_iterator(SI)); } void LLVMDisposeRelocationIterator(LLVMRelocationIteratorRef SI) { delete unwrap(SI); } LLVMBool LLVMIsRelocationIteratorAtEnd(LLVMSectionIteratorRef Section, LLVMRelocationIteratorRef SI) { return (*unwrap(SI) == (*unwrap(Section))->relocation_end()) ? 1 : 0; } void LLVMMoveToNextRelocation(LLVMRelocationIteratorRef SI) { ++(*unwrap(SI)); } // SymbolRef accessors const char *LLVMGetSymbolName(LLVMSymbolIteratorRef SI) { Expected Ret = (*unwrap(SI))->getName(); if (!Ret) { std::string Buf; raw_string_ostream OS(Buf); logAllUnhandledErrors(Ret.takeError(), OS); OS.flush(); report_fatal_error(Buf); } return Ret->data(); } uint64_t LLVMGetSymbolAddress(LLVMSymbolIteratorRef SI) { Expected Ret = (*unwrap(SI))->getAddress(); if (!Ret) { std::string Buf; raw_string_ostream OS(Buf); logAllUnhandledErrors(Ret.takeError(), OS); OS.flush(); report_fatal_error(Buf); } return *Ret; } uint64_t LLVMGetSymbolSize(LLVMSymbolIteratorRef SI) { return (*unwrap(SI))->getCommonSize(); } // RelocationRef accessors uint64_t LLVMGetRelocationOffset(LLVMRelocationIteratorRef RI) { return (*unwrap(RI))->getOffset(); } LLVMSymbolIteratorRef LLVMGetRelocationSymbol(LLVMRelocationIteratorRef RI) { symbol_iterator ret = (*unwrap(RI))->getSymbol(); return wrap(new symbol_iterator(ret)); } uint64_t LLVMGetRelocationType(LLVMRelocationIteratorRef RI) { return (*unwrap(RI))->getType(); } // NOTE: Caller takes ownership of returned string. const char *LLVMGetRelocationTypeName(LLVMRelocationIteratorRef RI) { SmallVector ret; (*unwrap(RI))->getTypeName(ret); char *str = static_cast(safe_malloc(ret.size())); llvm::copy(ret, str); return str; } // NOTE: Caller takes ownership of returned string. const char *LLVMGetRelocationValueString(LLVMRelocationIteratorRef RI) { return strdup(""); }