[DebugInfo] Fix printing values of forms which depend on the DWARF format.

[ikudrin]

Summary

The values are 8 bytes long in DWARF64, so they should not be cut to uint32_t on dumping.

[probinson]

If the value to be printed is only 10 digits wide, I think we do not get 6 leading zeros? Is that how we are formatting 64-bit values in general?

[ikudrin]

In D79093#2010585, @probinson wrote:

If the value to be printed is only 10 digits wide, I think we do not get 6 leading zeros? Is that how we are formatting 64-bit values in general?

Yes, that is how we print such values in most cases. I am going to prepare a separate patch to print DWARF64 values with extended width, based on the suggestion by @dblaikie in D78208.

[probinson]

LGTM

[jhenderson]

llvm/unittests/DebugInfo/DWARF/DWARFFormValueTest.cpp

375–380

It might be worth adding a test case where not all 16 digits are produced, to show that we don't print leading zeroes.

Also, is it worth DWARF32 test cases? Not sure, and maybe not.

[ikudrin]

• Shortened values in the test.
• Added DWARF32 test cases for the same forms. They might be useful later to show the difference in dumping DWARF32/64 variants.

[krasimir]

Reverted a git revision as a follow-up of this in https://github.com/llvm/llvm-project/commit/c5e0967e4cf0f1337bec772949e6cede4c01354b because of:

Newly added test fails:
FAIL: LLVM::DW_OP_call_ref_unexpected.s

http://lab.llvm.org:8011/builders/clang-x86_64-debian-fast/builds/28298

llvm/lib/DebugInfo/DWARF/DWARFFormValue.cpp

void DWARFFormValue::dump(raw_ostream &OS, DIDumpOptions DumpOpts) const {
   case DW_FORM_sdata:
     OS << Value.sval;
     break;
   case DW_FORM_udata:
     OS << Value.uval;
     break;
   case DW_FORM_strp:
     if (DumpOpts.Verbose)
-      OS << format(" .debug_str[0x%8.8x] = ", (uint32_t)UValue);
+      OS << format(" .debug_str[0x%8.8" PRIx64 "] = ", UValue);
     dumpString(OS);
     break;
   case DW_FORM_line_strp:
     if (DumpOpts.Verbose)
-      OS << format(" .debug_line_str[0x%8.8x] = ", (uint32_t)UValue);
+      OS << format(" .debug_line_str[0x%8.8" PRIx64 "] = ", UValue);
     dumpString(OS);
     break;
   case DW_FORM_strx:
   case DW_FORM_strx1:
   case DW_FORM_strx2:
   case DW_FORM_strx3:
   case DW_FORM_strx4:
   case DW_FORM_GNU_str_index:
void DWARFFormValue::dump(raw_ostream &OS, DIDumpOptions DumpOpts) const {
   case DW_FORM_rnglistx:
     OS << format("indexed (0x%x) rangelist = ", (uint32_t)UValue);
     break;
 
   case DW_FORM_loclistx:
     OS << format("indexed (0x%x) loclist = ", (uint32_t)UValue);
     break;
 
-  // Should be formatted to 64-bit for DWARF64.
   case DW_FORM_sec_offset:
-    AddrOS << format("0x%08x", (uint32_t)UValue);
+    AddrOS << format("0x%08" PRIx64, UValue);
     break;
 
   default:
     OS << format("DW_FORM(0x%4.4x)", Form);
     break;
   }
 
   if (CURelativeOffset) {

llvm/unittests/DebugInfo/DWARF/DWARFFormValueTest.cpp

testing::Values(
         ErrorParams{DW_FORM_data4, {}}, ErrorParams{DW_FORM_data8, {}},
         ErrorParams{DW_FORM_data16, {}}, ErrorParams{DW_FORM_sdata, {}},
         ErrorParams{DW_FORM_udata, {}}, ErrorParams{DW_FORM_string, {}},
         ErrorParams{DW_FORM_indirect, {}},
         ErrorParams{DW_FORM_indirect, {DW_FORM_data1}},
         ErrorParams{DW_FORM_strp_sup, {}},
         ErrorParams{DW_FORM_ref_sig8, {}}), );
 
+using DumpValueParams =
+    std::tuple<Form, ArrayRef<uint8_t>, DwarfFormat, StringRef>;
+struct DumpValueFixture : public testing::TestWithParam<DumpValueParams> {
+  void SetUp() override {
+    std::tie(Fm, InitialData, Format, ExpectedResult) = GetParam();
+  }
+
+  Form Fm;
+  ArrayRef<uint8_t> InitialData;
+  DwarfFormat Format;
+  StringRef ExpectedResult;
+};
+
+TEST_P(DumpValueFixture, Test) {
+  SCOPED_TRACE(formatv("Fm = {0}, InitialData = [{1}], Format = {2}", Fm,
+                       toHex(InitialData),
+                       Format == DWARF64 ? "DWARF64" : "DWARF32"));
+  DWARFDataExtractor Data(InitialData, sys::IsLittleEndianHost, 8);
+  DWARFFormValue Form(Fm);
+  uint64_t Offset = 0;
+  Form.extractValue(Data, &Offset, {0, 0, Format});
+
+  std::string Output;
+  raw_string_ostream OS(Output);
+
+  DIDumpOptions Opts;
+  Opts.Verbose = true;
+  Opts.ShowAddresses = true;
+
+  Form.dump(OS, Opts);
+  OS.flush();
+
+  EXPECT_EQ(Output, ExpectedResult);
+}
+
+const uint32_t DumpTestSample32Val = 0x112233;
+ArrayRef<uint8_t> DumpTestSample32 = toBytes(DumpTestSample32Val);
+const uint64_t DumpTestSample64Val = 0x11223344556677;
+ArrayRef<uint8_t> DumpTestSample64 = toBytes(DumpTestSample64Val);
+
+INSTANTIATE_TEST_CASE_P(
+    DumpValueParams, DumpValueFixture,
+    testing::Values(DumpValueParams{DW_FORM_strp, DumpTestSample32, DWARF32,
+                                    " .debug_str[0x00112233] = "},
+                    DumpValueParams{DW_FORM_strp, DumpTestSample64, DWARF64,
+                                    " .debug_str[0x11223344556677] = "},
+                    DumpValueParams{DW_FORM_line_strp, DumpTestSample32,
+                                    DWARF32, " .debug_line_str[0x00112233] = "},
+                    DumpValueParams{DW_FORM_line_strp, DumpTestSample64,
+                                    DWARF64,
+                                    " .debug_line_str[0x11223344556677] = "},
+                    DumpValueParams{DW_FORM_sec_offset, DumpTestSample32,
+                                    DWARF32, "0x00112233"},
+                    DumpValueParams{DW_FORM_sec_offset, DumpTestSample64,
+                                    DWARF64, "0x11223344556677"}), );
+
 } // end anonymous namespace