diff --git a/llvm/test/tools/llvm-readobj/MachO/stabs.yaml b/llvm/test/tools/llvm-readobj/MachO/stabs-sorted.yaml copy from llvm/test/tools/llvm-readobj/MachO/stabs.yaml copy to llvm/test/tools/llvm-readobj/MachO/stabs-sorted.yaml --- a/llvm/test/tools/llvm-readobj/MachO/stabs.yaml +++ b/llvm/test/tools/llvm-readobj/MachO/stabs-sorted.yaml @@ -1,57 +1,55 @@ -## Verify that llvm-readobj can dump files containing stabs symbols, -## particularly symbols of type N_OSO which have repurposed the n_sect field -## to store a non-section-index value. +## Verify that llvm-readobj can dump files with stab symbols in a sorted order, # RUN: yaml2obj %s -o %t -# RUN: llvm-readobj --syms %t | FileCheck %s +# RUN: llvm-readobj --syms --sort-symbols %t | FileCheck %s --check-prefix=SORTED -# CHECK: Symbols [ -# CHECK-NEXT: Symbol { -# CHECK-NEXT: Name: /Volumes/Sandbox/ (2) -# CHECK-NEXT: Type: SymDebugTable (0x64) -# CHECK-NEXT: Section: (0x0) -# CHECK-NEXT: RefType: UndefinedNonLazy (0x0) -# CHECK-NEXT: Flags [ (0x0) -# CHECK-NEXT: ] -# CHECK-NEXT: Value: 0x0 -# CHECK-NEXT: } -# CHECK-NEXT: Symbol { -# CHECK-NEXT: Name: /Volumes/Sandbox/test.o (20) -# CHECK-NEXT: Type: SymDebugTable (0x66) -# CHECK-NEXT: Section: (0x3) -# CHECK-NEXT: RefType: ReferenceFlagUndefinedLazy (0x1) -# CHECK-NEXT: Flags [ (0x0) -# CHECK-NEXT: ] -# CHECK-NEXT: Value: 0x5F72D5E2 -# CHECK-NEXT: } -# CHECK-NEXT: Symbol { -# CHECK-NEXT: Name: (1) -# CHECK-NEXT: Type: SymDebugTable (0x2E) -# CHECK-NEXT: Section: (0x1) -# CHECK-NEXT: RefType: UndefinedNonLazy (0x0) -# CHECK-NEXT: Flags [ (0x0) -# CHECK-NEXT: ] -# CHECK-NEXT: Value: 0x100000FA0 -# CHECK-NEXT: } -# CHECK-NEXT: Symbol { -# CHECK-NEXT: Name: _foo (44) -# CHECK-NEXT: Type: SymDebugTable (0x24) -# CHECK-NEXT: Section: (0x1) -# CHECK-NEXT: RefType: UndefinedNonLazy (0x0) -# CHECK-NEXT: Flags [ (0x0) -# CHECK-NEXT: ] -# CHECK-NEXT: Value: 0x100000FA0 -# CHECK-NEXT: } -# CHECK-NEXT: Symbol { -# CHECK-NEXT: Name: (1) -# CHECK-NEXT: Type: SymDebugTable (0x4E) -# CHECK-NEXT: Section: (0x1) -# CHECK-NEXT: RefType: UndefinedNonLazy (0x0) -# CHECK-NEXT: Flags [ (0x0) -# CHECK-NEXT: ] -# CHECK-NEXT: Value: 0xF -# CHECK-NEXT: } -# CHECK-NEXT: ] +# SORTED: Symbols [ +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: _foo (44) +# SORTED-NEXT: Type: SymDebugTable (0x24) +# SORTED-NEXT: Section: (0x1) +# SORTED-NEXT: RefType: UndefinedNonLazy (0x0) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0x100000FA0 +# SORTED-NEXT: } +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: (1) +# SORTED-NEXT: Type: SymDebugTable (0x2E) +# SORTED-NEXT: Section: (0x1) +# SORTED-NEXT: RefType: UndefinedNonLazy (0x0) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0x100000FA0 +# SORTED-NEXT: } +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: (1) +# SORTED-NEXT: Type: SymDebugTable (0x4E) +# SORTED-NEXT: Section: (0x1) +# SORTED-NEXT: RefType: UndefinedNonLazy (0x0) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0xF +# SORTED-NEXT: } +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: /Volumes/Sandbox/ (2) +# SORTED-NEXT: Type: SymDebugTable (0x64) +# SORTED-NEXT: Section: (0x0) +# SORTED-NEXT: RefType: UndefinedNonLazy (0x0) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0x0 +# SORTED-NEXT: } +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: /Volumes/Sandbox/test.o (20) +# SORTED-NEXT: Type: SymDebugTable (0x66) +# SORTED-NEXT: Section: (0x3) +# SORTED-NEXT: RefType: ReferenceFlagUndefinedLazy (0x1) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0x5F72D5E2 +# SORTED-NEXT: } +# SORTED-NEXT: ] --- !mach-o FileHeader: diff --git a/llvm/test/tools/llvm-readobj/MachO/stabs.yaml b/llvm/test/tools/llvm-readobj/MachO/stabs.yaml --- a/llvm/test/tools/llvm-readobj/MachO/stabs.yaml +++ b/llvm/test/tools/llvm-readobj/MachO/stabs.yaml @@ -53,6 +53,56 @@ # CHECK-NEXT: } # CHECK-NEXT: ] +# RUN: llvm-readobj --syms --sort-symbols %t | FileCheck %s --check-prefix=SORTED + +# SORTED: Symbols [ +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: _foo (44) +# SORTED-NEXT: Type: SymDebugTable (0x24) +# SORTED-NEXT: Section: (0x1) +# SORTED-NEXT: RefType: UndefinedNonLazy (0x0) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0x100000FA0 +# SORTED-NEXT: } +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: (1) +# SORTED-NEXT: Type: SymDebugTable (0x2E) +# SORTED-NEXT: Section: (0x1) +# SORTED-NEXT: RefType: UndefinedNonLazy (0x0) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0x100000FA0 +# SORTED-NEXT: } +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: (1) +# SORTED-NEXT: Type: SymDebugTable (0x4E) +# SORTED-NEXT: Section: (0x1) +# SORTED-NEXT: RefType: UndefinedNonLazy (0x0) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0xF +# SORTED-NEXT: } +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: /Volumes/Sandbox/ (2) +# SORTED-NEXT: Type: SymDebugTable (0x64) +# SORTED-NEXT: Section: (0x0) +# SORTED-NEXT: RefType: UndefinedNonLazy (0x0) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0x0 +# SORTED-NEXT: } +# SORTED-NEXT: Symbol { +# SORTED-NEXT: Name: /Volumes/Sandbox/test.o (20) +# SORTED-NEXT: Type: SymDebugTable (0x66) +# SORTED-NEXT: Section: (0x3) +# SORTED-NEXT: RefType: ReferenceFlagUndefinedLazy (0x1) +# SORTED-NEXT: Flags [ (0x0) +# SORTED-NEXT: ] +# SORTED-NEXT: Value: 0x5F72D5E2 +# SORTED-NEXT: } +# SORTED-NEXT: ] + --- !mach-o FileHeader: magic: 0xFEEDFACF diff --git a/llvm/tools/llvm-readobj/MachODumper.cpp b/llvm/tools/llvm-readobj/MachODumper.cpp --- a/llvm/tools/llvm-readobj/MachODumper.cpp +++ b/llvm/tools/llvm-readobj/MachODumper.cpp @@ -17,7 +17,12 @@ #include "llvm/ADT/StringExtras.h" #include "llvm/Object/MachO.h" #include "llvm/Support/Casting.h" +#include "llvm/Support/FormattedStream.h" #include "llvm/Support/ScopedPrinter.h" +#include "llvm/Support/raw_ostream.h" + +#include +#include using namespace llvm; using namespace object; @@ -49,8 +54,9 @@ template void printFileHeaders(const MachHeader &Header); - void printSymbols() override; - void printDynamicSymbols() override; + void printSymbols(bool SortSymbols) override; + void printDynamicSymbols(bool SortSymbols) override; + void printSymbol(const SymbolRef &Symbol, ScopedPrinter &W); void printSymbol(const SymbolRef &Symbol); void printRelocation(const RelocationRef &Reloc); @@ -601,19 +607,64 @@ } } -void MachODumper::printSymbols() { +void MachODumper::printSymbols(bool SortSymbols) { ListScope Group(W, "Symbols"); - for (const SymbolRef &Symbol : Obj->symbols()) { - printSymbol(Symbol); + if (SortSymbols) { + // The references returned by calling Obj->symbols() are temporary + // and we can't hold onto them after the loop. In order to sort the symbols, + // we have to print their representation to string and sort them later. + + assert(opts::Output != opts::JSON && "not expecting JSON format yet."); + // Tuple of + // Sort by type (local/external/undefined), then name. + std::vector> SortedSymbols; + for (SymbolRef Symbol : Obj->symbols()) { + std::string SymRep; + raw_string_ostream StringOs(SymRep); + formatted_raw_ostream FormattedOs(StringOs); + ScopedPrinter Printer(FormattedOs); + Printer.indent(W.getIndentLevel()); + printSymbol(Symbol, Printer); + + const DataRefImpl &DRI = Symbol.getRawDataRefImpl(); + SortedSymbols.emplace_back(Obj->getSymbol64TableEntry(DRI).n_type, + Symbol.getName()->str(), std::move(SymRep)); + } + + llvm::stable_sort( + SortedSymbols, + [](const std::tuple &LHS, + const std::tuple &RHS) { + uint8_t LType = std::get<0>(LHS); + uint8_t RType = std::get<0>(RHS); + + if (LType == RType) + return std::get<1>(LHS).compare(std::get<1>(RHS)) < 0; + return LType < RType; + // TODO:: Maybe use Symbol's addresses as tie-breaker if + // names are the same. + }); + + // Unindent one level because the Symbols were already padded. + W.unindent(); + for (auto &Tup : SortedSymbols) + W.startLine() << std::get<2>(Tup); + } else { + for (SymbolRef Symbol : Obj->symbols()) + printSymbol(Symbol); } } -void MachODumper::printDynamicSymbols() { +void MachODumper::printDynamicSymbols(bool SortSymbols) { ListScope Group(W, "DynamicSymbols"); } void MachODumper::printSymbol(const SymbolRef &Symbol) { + printSymbol(Symbol, W); +} + +void MachODumper::printSymbol(const SymbolRef &Symbol, ScopedPrinter &W) { StringRef SymbolName; Expected SymbolNameOrErr = Symbol.getName(); if (!SymbolNameOrErr) { diff --git a/llvm/tools/llvm-readobj/ObjDumper.h b/llvm/tools/llvm-readobj/ObjDumper.h --- a/llvm/tools/llvm-readobj/ObjDumper.h +++ b/llvm/tools/llvm-readobj/ObjDumper.h @@ -47,10 +47,14 @@ virtual void printSectionHeaders() = 0; virtual void printRelocations() = 0; virtual void printSymbols(bool PrintSymbols, bool PrintDynamicSymbols) { + printSymbols(PrintSymbols, PrintDynamicSymbols, false); + } + virtual void printSymbols(bool PrintSymbols, bool PrintDynamicSymbols, + bool SortSymbols) { if (PrintSymbols) - printSymbols(); + printSymbols(SortSymbols); if (PrintDynamicSymbols) - printDynamicSymbols(); + printDynamicSymbols(SortSymbols); } virtual void printProgramHeaders(bool PrintProgramHeaders, cl::boolOrDefault PrintSectionMapping) { @@ -132,8 +136,10 @@ ScopedPrinter &W; private: - virtual void printSymbols() {} - virtual void printDynamicSymbols() {} + virtual void printSymbols() { printSymbols(false); } + virtual void printSymbols(bool SortSymbols) {} + virtual void printDynamicSymbols() { printDynamicSymbols(false); } + virtual void printDynamicSymbols(bool SortSymbols) {} virtual void printProgramHeaders() {} virtual void printSectionMapping() {} diff --git a/llvm/tools/llvm-readobj/Opts.td b/llvm/tools/llvm-readobj/Opts.td --- a/llvm/tools/llvm-readobj/Opts.td +++ b/llvm/tools/llvm-readobj/Opts.td @@ -43,6 +43,7 @@ def string_table : FF<"string-table", "Display the string table (only for XCOFF now)">; def symbols : FF<"symbols", "Display the symbol table. Also display the dynamic symbol table when using GNU output style for ELF">; def unwind : FF<"unwind", "Display unwind information">; +def sort_symbols : FF<"sort-symbols", "Sort symbol before outputing symtab">; // ELF specific options. def grp_elf : OptionGroup<"kind">, HelpText<"OPTIONS (ELF specific)">; diff --git a/llvm/tools/llvm-readobj/llvm-readobj.cpp b/llvm/tools/llvm-readobj/llvm-readobj.cpp --- a/llvm/tools/llvm-readobj/llvm-readobj.cpp +++ b/llvm/tools/llvm-readobj/llvm-readobj.cpp @@ -113,6 +113,7 @@ static bool Symbols; static bool UnwindInfo; static cl::boolOrDefault SectionMapping; +static bool SortSymbols; // ELF specific options. static bool DynamicTable; @@ -253,6 +254,7 @@ opts::ProgramHeaders = Args.hasArg(OPT_program_headers); opts::RawRelr = Args.hasArg(OPT_raw_relr); opts::SectionGroups = Args.hasArg(OPT_section_groups); + opts::SortSymbols = Args.hasArg(OPT_sort_symbols); opts::VersionInfo = Args.hasArg(OPT_version_info); // Mach-O specific options. @@ -374,7 +376,8 @@ if (opts::UnwindInfo) Dumper->printUnwindInfo(); if (opts::Symbols || opts::DynamicSymbols) - Dumper->printSymbols(opts::Symbols, opts::DynamicSymbols); + Dumper->printSymbols(opts::Symbols, opts::DynamicSymbols, + opts::SortSymbols); if (!opts::StringDump.empty()) Dumper->printSectionsAsString(Obj, opts::StringDump); if (!opts::HexDump.empty())