[llvm] e3547ad - [DebugInfo] Improve new line printing in debug line verbose output
James Henderson via llvm-commits
llvm-commits at lists.llvm.org
Tue Jun 9 06:31:48 PDT 2020
Author: James Henderson
Date: 2020-06-09T14:27:16+01:00
New Revision: e3547ade68232d74bffd0e126cc0ea0b3970fbf7
URL: https://github.com/llvm/llvm-project/commit/e3547ade68232d74bffd0e126cc0ea0b3970fbf7
DIFF: https://github.com/llvm/llvm-project/commit/e3547ade68232d74bffd0e126cc0ea0b3970fbf7.diff
LOG: [DebugInfo] Improve new line printing in debug line verbose output
The new line printing for debug line verbose output was inconsistent.
For new rows in the matrix, a blank line followed, whilst the
DW_LNS_copy opcode actually resulted in two blank lines. There was also
potential inconsistency in the blank lines at the end of the table. This
patch mostly resolves these issues - no blank lines appear in the output
except for a single line after the prologue and at table end to separate
it from any subsquent table, plus some instances after error messages.
Also add a unit test for verbose output to test the fine details of new
line placement and other aspects of verbose output.
Reviewed by: dblaikie
Differential Revision: https://reviews.llvm.org/D81102
Added:
Modified:
llvm/lib/DebugInfo/DWARF/DWARFDebugLine.cpp
llvm/test/tools/llvm-dwarfdump/X86/debug_line_invalid.test
llvm/test/tools/llvm-dwarfdump/X86/verbose.test
llvm/unittests/DebugInfo/DWARF/DWARFDebugLineTest.cpp
Removed:
################################################################################
diff --git a/llvm/lib/DebugInfo/DWARF/DWARFDebugLine.cpp b/llvm/lib/DebugInfo/DWARF/DWARFDebugLine.cpp
index f35d45b9585f..62da2c59c048 100644
--- a/llvm/lib/DebugInfo/DWARF/DWARFDebugLine.cpp
+++ b/llvm/lib/DebugInfo/DWARF/DWARFDebugLine.cpp
@@ -706,8 +706,13 @@ Error DWARFDebugLine::LineTable::parse(
Prologue.dump(*OS, DumpOptions);
}
- if (PrologueErr)
+ if (PrologueErr) {
+ // Ensure there is a blank line after the prologue to clearly delineate it
+ // from later dumps.
+ if (OS)
+ *OS << "\n";
return PrologueErr;
+ }
uint64_t ProgramLength = Prologue.TotalLength + Prologue.sizeofTotalLength();
if (!DebugLineData.isValidOffsetForDataOfSize(DebugLineOffset,
@@ -750,6 +755,7 @@ Error DWARFDebugLine::LineTable::parse(
uint64_t OpcodeOffset = *OffsetPtr;
uint8_t Opcode = TableData.getU8(OffsetPtr);
+ size_t RowCount = Rows.size();
if (Verbose)
*OS << format("%02.02" PRIx8 " ", Opcode);
@@ -922,8 +928,6 @@ Error DWARFDebugLine::LineTable::parse(
}
if (OS)
State.Row.dump(*OS);
- if (Verbose) // FIXME: Don't print this newline.
- *OS << "\n";
State.appendRowToMatrix();
break;
@@ -1064,7 +1068,10 @@ Error DWARFDebugLine::LineTable::parse(
State.appendRowToMatrix();
}
- if(Verbose)
+
+ // When a row is added to the matrix, it is also dumped, which includes a
+ // new line already, so don't add an extra one.
+ if (Verbose && Rows.size() == RowCount)
*OS << "\n";
}
diff --git a/llvm/test/tools/llvm-dwarfdump/X86/debug_line_invalid.test b/llvm/test/tools/llvm-dwarfdump/X86/debug_line_invalid.test
index 2b0bb3da5b0c..31f2fd31efb3 100644
--- a/llvm/test/tools/llvm-dwarfdump/X86/debug_line_invalid.test
+++ b/llvm/test/tools/llvm-dwarfdump/X86/debug_line_invalid.test
@@ -67,8 +67,8 @@
# NONFATAL-NEXT: total_length: 0x00000002
# NONFATAL-NEXT: format: DWARF32
# NONFATAL-NEXT: version: 0
+# NONFATAL-EMPTY:
# SOME-ERR-NEXT: warning: parsing line table prologue at offset 0x00000048: unsupported version 0
-# NONFATAL-NOT: prologue_length
## Version 1 table.
# NONFATAL: debug_line[0x0000004e]
@@ -76,8 +76,8 @@
# NONFATAL-NEXT: total_length: 0x00000002
# NONFATAL-NEXT: format: DWARF32
# NONFATAL-NEXT: version: 1
+# NONFATAL-EMPTY:
# SOME-ERR-NEXT: warning: parsing line table prologue at offset 0x0000004e: unsupported version 1
-# NONFATAL-NOT: prologue_length
## Malformed directory format with no path component.
# NONFATAL: debug_line[0x00000054]
diff --git a/llvm/test/tools/llvm-dwarfdump/X86/verbose.test b/llvm/test/tools/llvm-dwarfdump/X86/verbose.test
index 64b596af8383..253e9fae1e51 100644
--- a/llvm/test/tools/llvm-dwarfdump/X86/verbose.test
+++ b/llvm/test/tools/llvm-dwarfdump/X86/verbose.test
@@ -20,13 +20,10 @@
# CHECK-NEXT:0x00000029: 00 DW_LNE_set_address (0x0000000000000000)
# CHECK-NEXT:0x00000034: 01 DW_LNS_copy
# CHECK-NEXT: 0x0000000000000000 1 0 1 0 0 is_stmt
-# CHECK-EMPTY:
-# CHECK-EMPTY:
-# CHECK:0x00000035: 05 DW_LNS_set_column (12)
+# CHECK-NEXT:0x00000035: 05 DW_LNS_set_column (12)
# CHECK-NEXT:0x00000037: 0a DW_LNS_set_prologue_end
# CHECK-NEXT:0x00000038: 66 address += 6, line += 0
# CHECK-NEXT: 0x0000000000000006 1 12 1 0 0 is_stmt prologue_end
-# CHECK-EMPTY:
# CHECK-NEXT:0x00000039: 02 DW_LNS_advance_pc (2)
# CHECK-NEXT:0x0000003b: 00 DW_LNE_end_sequence
# CHECK-NEXT: 0x0000000000000008 1 12 1 0 0 is_stmt end_sequence
diff --git a/llvm/unittests/DebugInfo/DWARF/DWARFDebugLineTest.cpp b/llvm/unittests/DebugInfo/DWARF/DWARFDebugLineTest.cpp
index c73b04d031ca..9208217cf0bc 100644
--- a/llvm/unittests/DebugInfo/DWARF/DWARFDebugLineTest.cpp
+++ b/llvm/unittests/DebugInfo/DWARF/DWARFDebugLineTest.cpp
@@ -1247,25 +1247,52 @@ TEST_F(DebugLineBasicFixture, ParserIgnoresNonPrologueErrorsWhenSkipping) {
EXPECT_FALSE(Unrecoverable);
}
-TEST_F(DebugLineBasicFixture, ParserPrintsStandardOpcodesWhenRequested) {
- if (!setupGenerator())
+TEST_F(DebugLineBasicFixture, VerboseOutput) {
+ if (!setupGenerator(5))
return;
- using ValLen = dwarfgen::LineTable::ValueAndLength;
- LineTable < = Gen->addLineTable(DWARF32);
+ LineTable < = Gen->addLineTable();
+ LT.addByte(0); // Extended opcode with zero length.
+ LT.addByte(0);
+ // Zero-value extended opcode.
+ LT.addExtendedOpcode(2, 0, {{1, LineTable::Byte}});
+ // Unknown extended opcode.
+ LT.addExtendedOpcode(2, 0x42, {{1, LineTable::Byte}});
+ LT.addExtendedOpcode(9, DW_LNE_set_address,
+ {{0x123456789abcdef, LineTable::Quad}});
+ LT.addExtendedOpcode(6, DW_LNE_define_file,
+ {{'a', LineTable::Byte},
+ {'\0', LineTable::Byte},
+ {2, LineTable::ULEB},
+ {3, LineTable::ULEB},
+ {4, LineTable::ULEB}});
+ LT.addExtendedOpcode(2, DW_LNE_set_discriminator, {{0x7f, LineTable::ULEB}});
LT.addStandardOpcode(DW_LNS_copy, {});
- LT.addStandardOpcode(DW_LNS_advance_pc, {ValLen{11, LineTable::ULEB}});
- LT.addStandardOpcode(DW_LNS_advance_line, {ValLen{22, LineTable::SLEB}});
- LT.addStandardOpcode(DW_LNS_set_file, {ValLen{33, LineTable::ULEB}});
- LT.addStandardOpcode(DW_LNS_set_column, {ValLen{44, LineTable::ULEB}});
+ LT.addStandardOpcode(DW_LNS_advance_pc, {{11, LineTable::ULEB}});
+ LT.addStandardOpcode(DW_LNS_advance_line, {{22, LineTable::SLEB}});
+ LT.addStandardOpcode(DW_LNS_set_file, {{33, LineTable::ULEB}});
+ LT.addStandardOpcode(DW_LNS_set_column, {{44, LineTable::ULEB}});
LT.addStandardOpcode(DW_LNS_negate_stmt, {});
LT.addStandardOpcode(DW_LNS_set_basic_block, {});
LT.addStandardOpcode(DW_LNS_const_add_pc, {});
- LT.addStandardOpcode(DW_LNS_fixed_advance_pc, {ValLen{55, LineTable::Half}});
+ LT.addStandardOpcode(DW_LNS_fixed_advance_pc, {{55, LineTable::Half}});
LT.addStandardOpcode(DW_LNS_set_prologue_end, {});
LT.addStandardOpcode(DW_LNS_set_epilogue_begin, {});
- LT.addStandardOpcode(DW_LNS_set_isa, {ValLen{66, LineTable::ULEB}});
+ LT.addStandardOpcode(DW_LNS_set_isa, {{66, LineTable::ULEB}});
+ // Add unknown standard opcode.
+ LT.addStandardOpcode(
+ 0xd, {{1, LineTable::ULEB}, {0x123456789abcdef, LineTable::ULEB}});
+ LT.addByte(0xff); // Special opcode.
LT.addExtendedOpcode(1, DW_LNE_end_sequence, {});
+
+ // Adjust the prologue to account for the extra standard opcode.
+ DWARFDebugLine::Prologue Prologue = LT.createBasicPrologue();
+ ++Prologue.TotalLength;
+ ++Prologue.PrologueLength;
+ ++Prologue.OpcodeBase;
+ Prologue.StandardOpcodeLengths.push_back(2);
+ LT.setPrologue(Prologue);
+
generate();
DWARFDebugLine::SectionParser Parser(LineData, *Context, CUs, TUs);
@@ -1274,30 +1301,88 @@ TEST_F(DebugLineBasicFixture, ParserPrintsStandardOpcodesWhenRequested) {
Parser.parseNext(RecordRecoverable, RecordUnrecoverable, &OS,
/*Verbose=*/true);
OS.flush();
-
- EXPECT_FALSE(Recoverable);
- EXPECT_FALSE(Unrecoverable);
- auto InOutput = [&Output](char const *Str) {
- return Output.find(Str) != std::string::npos;
+ StringRef OutputRef(Output);
+
+ size_t Pos = 0;
+ auto NextLine = [&Pos, &OutputRef]() {
+ size_t EOL = OutputRef.find_first_of('\n', Pos);
+ StringRef Line = OutputRef.substr(Pos, EOL - Pos);
+ Pos = EOL + 1;
+ return Line;
};
- EXPECT_TRUE(InOutput("0x0000002e: 01 DW_LNS_copy\n")) << Output;
- EXPECT_TRUE(InOutput("0x0000002f: 02 DW_LNS_advance_pc (11)\n")) << Output;
- // FIXME: The value printed after DW_LNS_advance_line is currently the result
- // of the advance, but it should be the value being advanced by. See
- // https://bugs.llvm.org/show_bug.cgi?id=44261 for details.
- EXPECT_TRUE(InOutput("0x00000031: 03 DW_LNS_advance_line (23)\n")) << Output;
- EXPECT_TRUE(InOutput("0x00000033: 04 DW_LNS_set_file (33)\n")) << Output;
- EXPECT_TRUE(InOutput("0x00000035: 05 DW_LNS_set_column (44)\n")) << Output;
- EXPECT_TRUE(InOutput("0x00000037: 06 DW_LNS_negate_stmt\n")) << Output;
- EXPECT_TRUE(InOutput("0x00000038: 07 DW_LNS_set_basic_block\n")) << Output;
- EXPECT_TRUE(
- InOutput("0x00000039: 08 DW_LNS_const_add_pc (0x0000000000000011)\n"))
- << Output;
- EXPECT_TRUE(InOutput("0x0000003a: 09 DW_LNS_fixed_advance_pc (0x0037)\n"))
- << Output;
- EXPECT_TRUE(InOutput("0x0000003d: 0a DW_LNS_set_prologue_end\n")) << Output;
- EXPECT_TRUE(InOutput("0x0000003e: 0b DW_LNS_set_epilogue_begin\n")) << Output;
- EXPECT_TRUE(InOutput("0x0000003f: 0c DW_LNS_set_isa (66)\n")) << Output;
+ EXPECT_EQ(NextLine(), "Line table prologue:");
+ EXPECT_EQ(NextLine(), " total_length: 0x00000076");
+ EXPECT_EQ(NextLine(), " format: DWARF32");
+ EXPECT_EQ(NextLine(), " version: 5");
+ EXPECT_EQ(NextLine(), " address_size: 8");
+ EXPECT_EQ(NextLine(), " seg_select_size: 0");
+ EXPECT_EQ(NextLine(), " prologue_length: 0x0000002b");
+ EXPECT_EQ(NextLine(), " min_inst_length: 1");
+ EXPECT_EQ(NextLine(), "max_ops_per_inst: 1");
+ EXPECT_EQ(NextLine(), " default_is_stmt: 1");
+ EXPECT_EQ(NextLine(), " line_base: -5");
+ EXPECT_EQ(NextLine(), " line_range: 14");
+ EXPECT_EQ(NextLine(), " opcode_base: 14");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_copy] = 0");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_advance_pc] = 1");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_advance_line] = 1");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_set_file] = 1");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_set_column] = 1");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_negate_stmt] = 0");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_set_basic_block] = 0");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_const_add_pc] = 0");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_fixed_advance_pc] = 1");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_set_prologue_end] = 0");
+ EXPECT_EQ(NextLine(),
+ "standard_opcode_lengths[DW_LNS_set_epilogue_begin] = 0");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_set_isa] = 1");
+ EXPECT_EQ(NextLine(), "standard_opcode_lengths[DW_LNS_unknown_d] = 2");
+ EXPECT_EQ(NextLine(), "include_directories[ 0] = \"a dir\"");
+ EXPECT_EQ(NextLine(), "file_names[ 0]:");
+ EXPECT_EQ(NextLine(), " name: \"a file\"");
+ EXPECT_EQ(NextLine(), " dir_index: 0");
+ EXPECT_EQ(NextLine(), "");
+ EXPECT_EQ(NextLine(), " Address Line Column File ISA Discriminator Flags");
+ EXPECT_EQ(NextLine(), " ------------------ ------ ------ ------ --- ------------- -------------");
+ EXPECT_EQ(NextLine(),
+ "0x00000037: 00 Badly formed extended line op (length 0)");
+ EXPECT_EQ(NextLine(),
+ "0x00000039: 00 Unrecognized extended op 0x00 length 2");
+ EXPECT_EQ(NextLine(),
+ "0x0000003d: 00 Unrecognized extended op 0x42 length 2");
+ EXPECT_EQ(NextLine(),
+ "0x00000041: 00 DW_LNE_set_address (0x0123456789abcdef)");
+ EXPECT_EQ(NextLine(), "0x0000004c: 00 DW_LNE_define_file (a, dir=2, "
+ "mod_time=(0x0000000000000003), length=4)");
+ EXPECT_EQ(NextLine(), "0x00000054: 00 DW_LNE_set_discriminator (127)");
+ EXPECT_EQ(NextLine(), "0x00000058: 01 DW_LNS_copy");
+ EXPECT_EQ(NextLine(), " 0x0123456789abcdef 1 0 1 "
+ "0 127 is_stmt");
+ EXPECT_EQ(NextLine(), "0x00000059: 02 DW_LNS_advance_pc (11)");
+ EXPECT_EQ(NextLine(), "0x0000005b: 03 DW_LNS_advance_line (23)");
+ EXPECT_EQ(NextLine(), "0x0000005d: 04 DW_LNS_set_file (33)");
+ EXPECT_EQ(NextLine(), "0x0000005f: 05 DW_LNS_set_column (44)");
+ EXPECT_EQ(NextLine(), "0x00000061: 06 DW_LNS_negate_stmt");
+ EXPECT_EQ(NextLine(), "0x00000062: 07 DW_LNS_set_basic_block");
+ EXPECT_EQ(NextLine(),
+ "0x00000063: 08 DW_LNS_const_add_pc (0x0000000000000011)");
+ EXPECT_EQ(NextLine(), "0x00000064: 09 DW_LNS_fixed_advance_pc (0x0037)");
+ EXPECT_EQ(NextLine(), "0x00000067: 0a DW_LNS_set_prologue_end");
+ EXPECT_EQ(NextLine(), "0x00000068: 0b DW_LNS_set_epilogue_begin");
+ EXPECT_EQ(NextLine(), "0x00000069: 0c DW_LNS_set_isa (66)");
+ EXPECT_EQ(NextLine(),
+ "0x0000006b: 0d Skipping ULEB128 value: 0x0000000000000001)");
+ EXPECT_EQ(NextLine(), "Skipping ULEB128 value: 0x0123456789abcdef)");
+ EXPECT_EQ(NextLine(), "");
+ EXPECT_EQ(NextLine(), "0x00000076: ff address += 17, line += -2");
+ EXPECT_EQ(NextLine(),
+ " 0x0123456789abce53 21 44 33 66 "
+ " 0 basic_block prologue_end epilogue_begin");
+ EXPECT_EQ(NextLine(), "0x00000077: 00 DW_LNE_end_sequence");
+ EXPECT_EQ(NextLine(), " 0x0123456789abce53 21 44 33 "
+ "66 0 end_sequence");
+ EXPECT_EQ(NextLine(), "");
+ EXPECT_EQ(Output.size(), Pos);
}
using ValueAndLengths = std::vector<LineTable::ValueAndLength>;
More information about the llvm-commits
mailing list