[dwarfdump] Add -show-form

[JDevlieghere]

Summary

This enables printing of DWARF form types after the DWARF attribute
types. Feature parity with dwarfdump-classic.

[aprantl]

Thanks!

include/llvm/DebugInfo/DIContext.h

144

At some point we should convert this to a bitfield or into an enum bitfield.

test/tools/llvm-dwarfdump/X86/form.test

14

I find the naming confusing, I would expect FORM to check the case where -F is specified.

41

why not: FORM-NOT: DW_FORM_ and be done with it?

tools/llvm-dwarfdump/llvm-dwarfdump.cpp

174

please add all new options to the tools/llvm-dwarfdump/cmdline.test testcase, too, it catches bugs such as the wrong option category.

[aprantl]

LGTM with outstanding issues addressed.

[JDevlieghere]

In D38459#885844, @aprantl wrote:

At some point we should convert this to a bitfield or into an enum bitfield.

I agree, I will keep this for an separate NFC commit!

include/llvm/DebugInfo/DIContext.h

 
 /// Container for dump options that control which debug information will be
 /// dumped.
 struct DIDumpOptions {
   unsigned DumpType = DIDT_All;
   unsigned RecurseDepth = -1U;
   bool ShowChildren = false;
   bool ShowParents = false;
+  bool ShowForm = false;
   bool SummarizeTypes = false;
   bool Verbose = false;
 
   /// Return default option set for printing a single DIE without children.
   static DIDumpOptions getForSingleDIE() {
     DIDumpOptions Opts;
     Opts.RecurseDepth = 0;
     return Opts;

lib/DebugInfo/DWARF/DWARFDie.cpp

static void dumpAttribute(raw_ostream &OS, const DWARFDie &Die,
   OS << BaseIndent;
   OS.indent(Indent+2);
   auto attrString = AttributeString(Attr);
   if (!attrString.empty())
     WithColor(OS, syntax::Attribute) << attrString;
   else
     WithColor(OS, syntax::Attribute).get() << format("DW_AT_Unknown_%x", Attr);
 
-  if (DumpOpts.Verbose) {
+  if (DumpOpts.Verbose || DumpOpts.ShowForm) {
     auto formString = FormEncodingString(Form);
     if (!formString.empty())
       OS << " [" << formString << ']';
     else
       OS << format(" [DW_FORM_Unknown_%x]", Form);
   }
 
   DWARFUnit *U = Die.getDwarfUnit();

test/tools/llvm-dwarfdump/X86/form.test

+# This test verifies that DWARF form types are printed in verbose mode and when
+# passing -F but not in brief mode.
+
+# RUN: llvm-mc %S/brief.s -filetype obj -triple x86_64-apple-darwin -o - \
+# RUN: | llvm-dwarfdump -v --debug-info - \
+# RUN: | FileCheck %s
+
+# RUN: llvm-mc %S/brief.s -filetype obj -triple x86_64-apple-darwin -o - \
+# RUN: | llvm-dwarfdump -F --debug-info - \
+# RUN: | FileCheck %s
+
+# RUN: llvm-mc %S/brief.s -filetype obj -triple x86_64-apple-darwin -o - \
+# RUN: | llvm-dwarfdump --debug-info - \
+# RUN: | FileCheck %s --check-prefix FORM
+
+# CHECK: DW_TAG_compile_unit
+# CHECK: DW_AT_producer [DW_FORM_strp]
+# CHECK: DW_AT_language [DW_FORM_data2]
+# CHECK: DW_AT_name [DW_FORM_strp]
+# CHECK: DW_AT_stmt_list [DW_FORM_sec_offset]
+# CHECK: DW_AT_comp_dir [DW_FORM_strp]
+# CHECK: DW_AT_low_pc [DW_FORM_addr]
+# CHECK: DW_AT_high_pc [DW_FORM_data4]
+
+# CHECK: DW_TAG_subprogram
+# CHECK: DW_AT_low_pc [DW_FORM_addr]
+# CHECK: DW_AT_high_pc [DW_FORM_data4]
+# CHECK: DW_AT_frame_base [DW_FORM_exprloc]
+# CHECK: DW_AT_name [DW_FORM_strp]
+# CHECK: DW_AT_decl_file [DW_FORM_data1]
+# CHECK: DW_AT_decl_line [DW_FORM_data1]
+# CHECK: DW_AT_type [DW_FORM_ref4]
+# CHECK: DW_AT_external [DW_FORM_flag_present]
+
+# CHECK: DW_TAG_base_type
+# CHECK: DW_AT_name [DW_FORM_strp]
+# CHECK: DW_AT_encoding [DW_FORM_data1]
+# CHECK: DW_AT_byte_size [DW_FORM_data1]
+
+# FORM: DW_TAG_compile_unit
+# FORM-NOT: [DW_FORM_strp]
+# FORM-NOT: [DW_FORM_data2]
+# FORM-NOT: [DW_FORM_strp]
+# FORM-NOT: [DW_FORM_sec_offset]
+# FORM-NOT: [DW_FORM_strp]
+# FORM-NOT: [DW_FORM_addr]
+# FORM-NOT: [DW_FORM_data4]
+
+# FORM: DW_TAG_subprogram
+# FORM-NOT: [DW_FORM_addr]
+# FORM-NOT: [DW_FORM_data4]
+# FORM-NOT: [DW_FORM_exprloc]
+# FORM-NOT: [DW_FORM_strp]
+# FORM-NOT: [DW_FORM_data1]
+# FORM-NOT: [DW_FORM_data1]
+# FORM-NOT: [DW_FORM_ref4]
+# FORM-NOT: [DW_FORM_flag_present]
+
+# FORM: DW_TAG_base_type
+# FORM-NOT: [DW_FORM_strp]
+# FORM-NOT: [DW_FORM_data1]
+# FORM-NOT: [DW_FORM_data1]

tools/llvm-dwarfdump/llvm-dwarfdump.cpp

static alias ShowChildrenAlias("c", desc("Alias for -show-children"),
                                aliasopt(ShowChildren));
 static opt<bool>
     ShowParents("show-parents",
                 desc("Show a debug info entry's parents when selectively "
                      "printing with the =<offset> option"),
                 cat(DwarfDumpCategory));
 static alias ShowParentsAlias("p", desc("Alias for -show-parents"),
                               aliasopt(ShowParents));
+static opt<bool>
+    ShowForm("show-form",
+             desc("Show DWARF form types after the DWARF attribute types."),
+             cat(DwarfDumpCategory));
+static alias ShowFormAlias("F", desc("Alias for -show-form"),
+                           aliasopt(ShowForm), cat(DwarfDumpCategory));
 static opt<unsigned> RecurseDepth(
     "recurse-depth",
     desc("Only recurse to a depth of N when displaying debug info entries."),
     cat(DwarfDumpCategory), init(-1U), value_desc("N"));
 static alias RecurseDepthAlias("r", desc("Alias for -recurse-depth"),
                                aliasopt(RecurseDepth));
-  
 static opt<bool>
     SummarizeTypes("summarize-types",
                    desc("Abbreviate the description of type unit entries"),
                    cat(DwarfDumpCategory));
 static opt<bool> Verify("verify", desc("Verify the DWARF debug info"),
                         cat(DwarfDumpCategory));
 static opt<bool> Quiet("quiet", desc("Use with -verify to not emit to STDOUT."),
                        cat(DwarfDumpCategory));

 }
 
 static DIDumpOptions getDumpOpts() {
   DIDumpOptions DumpOpts;
   DumpOpts.DumpType = DumpType;
   DumpOpts.RecurseDepth = RecurseDepth;
   DumpOpts.ShowChildren = ShowChildren;
   DumpOpts.ShowParents = ShowParents;
+  DumpOpts.ShowForm = ShowForm;
   DumpOpts.SummarizeTypes = SummarizeTypes;
   DumpOpts.Verbose = Verbose;
   // In -verify mode, print DIEs without children in error messages.
   if (Verify)
     return DumpOpts.noImplicitRecursion();
   return DumpOpts;
 }
 
static bool dumpObjectFile(ObjectFile &Obj, DWARFContext &DICtx, Twine Filename,
   if (!(DumpType & DIDT_UUID) || DumpType == DIDT_All)
     OS << Filename << ":\tfile format " << Obj.getFileFormatName() << '\n';
 
   // Handle the --name option.
   if (!Name.empty()) {
     StringSet<> Names;
     for (auto name : Name)
       Names.insert(name);
-      
     filterByName(Names, DICtx.compile_units(), OS);
     filterByName(Names, DICtx.dwo_compile_units(), OS);
     return true;
   }
 
   // Handle the --find option and lower it to --debug-info=<offset>.
   if (!Find.empty()) {
     DumpOffsets[DIDT_ID_DebugInfo] = [&]() -> llvm::Optional<uint64_t> {
DumpOffsets[DIDT_ID_DebugInfo] = [&]() -> llvm::Optional<uint64_t> {
           return DumpOffsets[DIDT_ID_DebugInfo] = *Offset;
       }
       return None;
     }();
     // Early exit if --find was specified but the current file doesn't have it.
     if (!DumpOffsets[DIDT_ID_DebugInfo])
       return true;
   }
-  
   // Dump the complete DWARF structure.
   DICtx.dump(OS, getDumpOpts(), DumpOffsets);
   return true;
 }
 
 static bool verifyObjectFile(ObjectFile &Obj, DWARFContext &DICtx,
                              Twine Filename, raw_ostream &OS) {
   // Verify the DWARF and exit with non-zero exit status if verification