From d1ba3b13f83ebb7a76b62cacb1a97006c8d9f4b3 Mon Sep 17 00:00:00 2001 From: Robert Widmann Date: Tue, 9 Apr 2019 21:53:31 +0000 Subject: [PATCH] [LLVM-C] Add Section and Symbol Iterator Accessors for Object File Binaries Summary: This brings us to full feature parity with the old API, so I've deprecated it and updated the tests. I'll do a follow-up patch to do some more cleanup and documentation work in this header. Reviewers: whitequark, deadalnix Reviewed By: whitequark Subscribers: hiraditya, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D60407 llvm-svn: 358037 --- llvm/include/llvm-c/Object.h | 74 ++++++++++++++++++++++++++++----- llvm/lib/Object/Object.cpp | 28 +++++++++++++ llvm/tools/llvm-c-test/object.c | 52 +++++++++++++---------- 3 files changed, 122 insertions(+), 32 deletions(-) diff --git a/llvm/include/llvm-c/Object.h b/llvm/include/llvm-c/Object.h index ae20fef5b6df..76e6080dba05 100644 --- a/llvm/include/llvm-c/Object.h +++ b/llvm/include/llvm-c/Object.h @@ -34,7 +34,6 @@ extern "C" { */ // Opaque type wrappers -typedef struct LLVMOpaqueObjectFile *LLVMObjectFileRef; typedef struct LLVMOpaqueSectionIterator *LLVMSectionIteratorRef; typedef struct LLVMOpaqueSymbolIterator *LLVMSymbolIteratorRef; typedef struct LLVMOpaqueRelocationIterator *LLVMRelocationIteratorRef; @@ -103,25 +102,56 @@ LLVMMemoryBufferRef LLVMBinaryCopyMemoryBuffer(LLVMBinaryRef BR); */ LLVMBinaryType LLVMBinaryGetType(LLVMBinaryRef BR); +/** + * Retrieve a copy of the 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); -// ObjectFile creation -LLVMObjectFileRef LLVMCreateObjectFile(LLVMMemoryBufferRef MemBuf); -void LLVMDisposeObjectFile(LLVMObjectFileRef ObjectFile); +/** + * 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 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); -// ObjectFile Section iterators -LLVMSectionIteratorRef LLVMGetSections(LLVMObjectFileRef ObjectFile); void LLVMDisposeSectionIterator(LLVMSectionIteratorRef SI); -LLVMBool LLVMIsSectionIteratorAtEnd(LLVMObjectFileRef ObjectFile, - LLVMSectionIteratorRef SI); + void LLVMMoveToNextSection(LLVMSectionIteratorRef SI); void LLVMMoveToContainingSection(LLVMSectionIteratorRef Sect, LLVMSymbolIteratorRef Sym); // ObjectFile Symbol iterators -LLVMSymbolIteratorRef LLVMGetSymbols(LLVMObjectFileRef ObjectFile); void LLVMDisposeSymbolIterator(LLVMSymbolIteratorRef SI); -LLVMBool LLVMIsSymbolIteratorAtEnd(LLVMObjectFileRef ObjectFile, - LLVMSymbolIteratorRef SI); void LLVMMoveToNextSymbol(LLVMSymbolIteratorRef SI); // SectionRef accessors @@ -154,6 +184,28 @@ uint64_t LLVMGetRelocationType(LLVMRelocationIteratorRef RI); 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); /** * @} */ diff --git a/llvm/lib/Object/Object.cpp b/llvm/lib/Object/Object.cpp index 3a88477cea63..77e27ec3e8fd 100644 --- a/llvm/lib/Object/Object.cpp +++ b/llvm/lib/Object/Object.cpp @@ -131,6 +131,34 @@ LLVMBinaryType LLVMBinaryGetType(LLVMBinaryRef BR) { return BinaryTypeMapper::mapBinaryTypeToLLVMBinaryType(unwrap(BR)->getType()); } +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)); diff --git a/llvm/tools/llvm-c-test/object.c b/llvm/tools/llvm-c-test/object.c index 278911b0bc6f..53ffb1acaffe 100644 --- a/llvm/tools/llvm-c-test/object.c +++ b/llvm/tools/llvm-c-test/object.c @@ -19,23 +19,26 @@ int llvm_object_list_sections(void) { LLVMMemoryBufferRef MB; - LLVMObjectFileRef O; + LLVMBinaryRef O; LLVMSectionIteratorRef sect; - char *msg = NULL; - if (LLVMCreateMemoryBufferWithSTDIN(&MB, &msg)) { - fprintf(stderr, "Error reading file: %s\n", msg); + char *outBufferErr = NULL; + if (LLVMCreateMemoryBufferWithSTDIN(&MB, &outBufferErr)) { + fprintf(stderr, "Error reading file: %s\n", outBufferErr); + free(outBufferErr); exit(1); } - O = LLVMCreateObjectFile(MB); - if (!O) { - fprintf(stderr, "Error reading object\n"); + char *outBinaryErr = NULL; + O = LLVMCreateBinary(MB, LLVMGetGlobalContext(), &outBinaryErr); + if (!O || outBinaryErr) { + fprintf(stderr, "Error reading object: %s\n", outBinaryErr); + free(outBinaryErr); exit(1); } - sect = LLVMGetSections(O); - while (!LLVMIsSectionIteratorAtEnd(O, sect)) { + sect = LLVMObjectFileCopySectionIterator(O); + while (sect && !LLVMObjectFileIsSectionIteratorAtEnd(O, sect)) { printf("'%s': @0x%08" PRIx64 " +%" PRIu64 "\n", LLVMGetSectionName(sect), LLVMGetSectionAddress(sect), LLVMGetSectionSize(sect)); @@ -44,32 +47,37 @@ int llvm_object_list_sections(void) { LLVMDisposeSectionIterator(sect); - LLVMDisposeObjectFile(O); + LLVMDisposeBinary(O); + + LLVMDisposeMemoryBuffer(MB); return 0; } int llvm_object_list_symbols(void) { LLVMMemoryBufferRef MB; - LLVMObjectFileRef O; + LLVMBinaryRef O; LLVMSectionIteratorRef sect; LLVMSymbolIteratorRef sym; - char *msg = NULL; - if (LLVMCreateMemoryBufferWithSTDIN(&MB, &msg)) { - fprintf(stderr, "Error reading file: %s\n", msg); + char *outBufferErr = NULL; + if (LLVMCreateMemoryBufferWithSTDIN(&MB, &outBufferErr)) { + fprintf(stderr, "Error reading file: %s\n", outBufferErr); + free(outBufferErr); exit(1); } - O = LLVMCreateObjectFile(MB); - if (!O) { - fprintf(stderr, "Error reading object\n"); + char *outBinaryErr = NULL; + O = LLVMCreateBinary(MB, LLVMGetGlobalContext(), &outBinaryErr); + if (!O || outBinaryErr) { + fprintf(stderr, "Error reading object: %s\n", outBinaryErr); + free(outBinaryErr); exit(1); } - sect = LLVMGetSections(O); - sym = LLVMGetSymbols(O); - while (!LLVMIsSymbolIteratorAtEnd(O, sym)) { + sect = LLVMObjectFileCopySectionIterator(O); + sym = LLVMObjectFileCopySymbolIterator(O); + while (sect && sym && !LLVMObjectFileIsSymbolIteratorAtEnd(O, sym)) { LLVMMoveToContainingSection(sect, sym); printf("%s @0x%08" PRIx64 " +%" PRIu64 " (%s)\n", LLVMGetSymbolName(sym), @@ -81,7 +89,9 @@ int llvm_object_list_symbols(void) { LLVMDisposeSymbolIterator(sym); - LLVMDisposeObjectFile(O); + LLVMDisposeBinary(O); + + LLVMDisposeMemoryBuffer(MB); return 0; }