166702629SJames Henderson //===- DWARFDebugLineTest.cpp ---------------------------------------------===//
266702629SJames Henderson //
366702629SJames Henderson //                     The LLVM Compiler Infrastructure
466702629SJames Henderson //
566702629SJames Henderson // This file is distributed under the University of Illinois Open Source
666702629SJames Henderson // License. See LICENSE.TXT for details.
766702629SJames Henderson //
866702629SJames Henderson //===----------------------------------------------------------------------===//
966702629SJames Henderson 
1066702629SJames Henderson #include "DwarfGenerator.h"
1166702629SJames Henderson #include "DwarfUtils.h"
1266702629SJames Henderson #include "llvm/DebugInfo/DWARF/DWARFContext.h"
1366702629SJames Henderson #include "llvm/DebugInfo/DWARF/DWARFDebugLine.h"
1466702629SJames Henderson #include "llvm/Object/ObjectFile.h"
1566702629SJames Henderson #include "llvm/Testing/Support/Error.h"
1666702629SJames Henderson #include "gtest/gtest.h"
1766702629SJames Henderson 
1866702629SJames Henderson using namespace llvm;
1966702629SJames Henderson using namespace dwarf;
20a3acf99eSJames Henderson using namespace dwarfgen;
2166702629SJames Henderson using namespace object;
2266702629SJames Henderson using namespace utils;
23a3acf99eSJames Henderson using namespace testing;
2466702629SJames Henderson 
2566702629SJames Henderson namespace {
26a3acf99eSJames Henderson struct CommonFixture {
27a3acf99eSJames Henderson   CommonFixture()
28a3acf99eSJames Henderson       : LineData("", true, 0),
29a3acf99eSJames Henderson         RecordIssue(std::bind(&CommonFixture::recordIssue, this,
30a3acf99eSJames Henderson                               std::placeholders::_1)),
31a3acf99eSJames Henderson         FoundError(Error::success()),
32a3acf99eSJames Henderson         RecordError(std::bind(&CommonFixture::recordError, this,
33a3acf99eSJames Henderson                               std::placeholders::_1)){};
3466702629SJames Henderson 
35a3acf99eSJames Henderson   ~CommonFixture() { EXPECT_FALSE(FoundError); }
36a3acf99eSJames Henderson 
37a3acf99eSJames Henderson   bool setupGenerator(uint16_t Version = 4) {
3866702629SJames Henderson     Triple T = getHostTripleForAddrSize(8);
3966702629SJames Henderson     if (!isConfigurationSupported(T))
4066702629SJames Henderson       return false;
41a3acf99eSJames Henderson     auto ExpectedGenerator = Generator::create(T, Version);
4266702629SJames Henderson     if (ExpectedGenerator)
43a3acf99eSJames Henderson       Gen.reset(ExpectedGenerator->release());
4466702629SJames Henderson     return true;
4566702629SJames Henderson   }
4666702629SJames Henderson 
47a3acf99eSJames Henderson   void generate() {
48a3acf99eSJames Henderson     Context = createContext();
49a3acf99eSJames Henderson     assert(Context != nullptr && "test state is not valid");
50a3acf99eSJames Henderson     const DWARFObject &Obj = Context->getDWARFObj();
51a3acf99eSJames Henderson     LineData = DWARFDataExtractor(Obj, Obj.getLineSection(), true, 8);
52a3acf99eSJames Henderson   }
53a3acf99eSJames Henderson 
5466702629SJames Henderson   std::unique_ptr<DWARFContext> createContext() {
55a3acf99eSJames Henderson     if (!Gen)
5666702629SJames Henderson       return nullptr;
57a3acf99eSJames Henderson     StringRef FileBytes = Gen->generate();
5866702629SJames Henderson     MemoryBufferRef FileBuffer(FileBytes, "dwarf");
5966702629SJames Henderson     auto Obj = object::ObjectFile::createObjectFile(FileBuffer);
6066702629SJames Henderson     if (Obj)
6166702629SJames Henderson       return DWARFContext::create(**Obj);
6266702629SJames Henderson     return nullptr;
6366702629SJames Henderson   }
6466702629SJames Henderson 
65a3acf99eSJames Henderson   DWARFDebugLine::SectionParser setupParser() {
66a3acf99eSJames Henderson     LineTable &LT = Gen->addLineTable(DWARF32);
67a3acf99eSJames Henderson     LT.addExtendedOpcode(9, DW_LNE_set_address, {{0xadd4e55, LineTable::Quad}});
68a3acf99eSJames Henderson     LT.addStandardOpcode(DW_LNS_copy, {});
69a3acf99eSJames Henderson     LT.addByte(0xaa);
70a3acf99eSJames Henderson     LT.addExtendedOpcode(1, DW_LNE_end_sequence, {});
71a3acf99eSJames Henderson 
72a3acf99eSJames Henderson     LineTable &LT2 = Gen->addLineTable(DWARF64);
73a3acf99eSJames Henderson     LT2.addExtendedOpcode(9, DW_LNE_set_address,
74a3acf99eSJames Henderson                           {{0x11223344, LineTable::Quad}});
75a3acf99eSJames Henderson     LT2.addStandardOpcode(DW_LNS_copy, {});
76a3acf99eSJames Henderson     LT2.addByte(0xbb);
77a3acf99eSJames Henderson     LT2.addExtendedOpcode(1, DW_LNE_end_sequence, {});
78a3acf99eSJames Henderson 
79a3acf99eSJames Henderson     generate();
80a3acf99eSJames Henderson 
81a3acf99eSJames Henderson     return DWARFDebugLine::SectionParser(LineData, *Context, CUs, TUs);
82a3acf99eSJames Henderson   }
83a3acf99eSJames Henderson 
84a3acf99eSJames Henderson   void recordIssue(StringRef Message) { IssueMessage = Message; }
85a3acf99eSJames Henderson   void recordError(Error Err) {
86a3acf99eSJames Henderson     FoundError = joinErrors(std::move(FoundError), std::move(Err));
87a3acf99eSJames Henderson   }
88a3acf99eSJames Henderson 
89a3acf99eSJames Henderson   void checkError(ArrayRef<StringRef> ExpectedMsgs, Error Err) {
90a3acf99eSJames Henderson     ASSERT_TRUE(Err.operator bool());
91a3acf99eSJames Henderson     size_t WhichMsg = 0;
92a3acf99eSJames Henderson     Error Remaining =
93a3acf99eSJames Henderson         handleErrors(std::move(Err), [&](const ErrorInfoBase &Actual) {
94a3acf99eSJames Henderson           ASSERT_LT(WhichMsg, ExpectedMsgs.size());
95a3acf99eSJames Henderson           // Use .str(), because googletest doesn't visualise a StringRef
96a3acf99eSJames Henderson           // properly.
97a3acf99eSJames Henderson           EXPECT_EQ(Actual.message(), ExpectedMsgs[WhichMsg++].str());
98a3acf99eSJames Henderson         });
99a3acf99eSJames Henderson     EXPECT_EQ(WhichMsg, ExpectedMsgs.size());
100a3acf99eSJames Henderson     EXPECT_FALSE(Remaining);
101a3acf99eSJames Henderson   }
102a3acf99eSJames Henderson 
103a3acf99eSJames Henderson   void checkError(StringRef ExpectedMsg, Error Err) {
104a3acf99eSJames Henderson     checkError(ArrayRef<StringRef>{ExpectedMsg}, std::move(Err));
105a3acf99eSJames Henderson   }
106a3acf99eSJames Henderson 
107a3acf99eSJames Henderson   void checkGetOrParseLineTableEmitsError(StringRef ExpectedMsg,
108a3acf99eSJames Henderson                                           uint64_t Offset = 0) {
109a3acf99eSJames Henderson     auto ExpectedLineTable = Line.getOrParseLineTable(
110a3acf99eSJames Henderson         LineData, Offset, *Context, nullptr, RecordIssue);
111a3acf99eSJames Henderson     EXPECT_FALSE(ExpectedLineTable);
112a3acf99eSJames Henderson     EXPECT_TRUE(IssueMessage.empty());
113a3acf99eSJames Henderson 
114a3acf99eSJames Henderson     checkError(ExpectedMsg, ExpectedLineTable.takeError());
115a3acf99eSJames Henderson   }
116a3acf99eSJames Henderson 
117a3acf99eSJames Henderson   std::unique_ptr<Generator> Gen;
118a3acf99eSJames Henderson   std::unique_ptr<DWARFContext> Context;
119a3acf99eSJames Henderson   DWARFDataExtractor LineData;
120a3acf99eSJames Henderson   DWARFDebugLine Line;
121a3acf99eSJames Henderson   std::string IssueMessage;
122a3acf99eSJames Henderson   std::function<void(StringRef)> RecordIssue;
123a3acf99eSJames Henderson   Error FoundError;
124a3acf99eSJames Henderson   std::function<void(Error)> RecordError;
125a3acf99eSJames Henderson 
126a3acf99eSJames Henderson   SmallVector<std::unique_ptr<DWARFCompileUnit>, 2> CUs;
127a3acf99eSJames Henderson   std::deque<DWARFUnitSection<DWARFTypeUnit>> TUs;
12866702629SJames Henderson };
12966702629SJames Henderson 
130a3acf99eSJames Henderson // Fixtures must derive from "Test", but parameterised fixtures from
131a3acf99eSJames Henderson // "TestWithParam". It does not seem possible to inherit from both, so we share
132a3acf99eSJames Henderson // the common state in a separate class, inherited by the two fixture classes.
133a3acf99eSJames Henderson struct DebugLineBasicFixture : public Test, public CommonFixture {};
134a3acf99eSJames Henderson 
135a3acf99eSJames Henderson struct DebugLineParameterisedFixture
136a3acf99eSJames Henderson     : public TestWithParam<std::pair<uint16_t, DwarfFormat>>,
137a3acf99eSJames Henderson       public CommonFixture {
138a3acf99eSJames Henderson   void SetUp() { std::tie(Version, Format) = GetParam(); }
139a3acf99eSJames Henderson 
140a3acf99eSJames Henderson   uint16_t Version;
141a3acf99eSJames Henderson   DwarfFormat Format;
142a3acf99eSJames Henderson };
143a3acf99eSJames Henderson 
144a3acf99eSJames Henderson void checkDefaultPrologue(uint16_t Version, DwarfFormat Format,
145a3acf99eSJames Henderson                           DWARFDebugLine::Prologue Prologue,
146a3acf99eSJames Henderson                           uint64_t BodyLength) {
147a3acf99eSJames Henderson   // Check version specific fields and values.
148a3acf99eSJames Henderson   uint64_t UnitLength;
149a3acf99eSJames Henderson   uint64_t PrologueLength;
150a3acf99eSJames Henderson   switch (Version) {
151a3acf99eSJames Henderson   case 4:
152a3acf99eSJames Henderson     PrologueLength = 36;
153a3acf99eSJames Henderson     UnitLength = PrologueLength + 2;
154*11a9de74SJames Henderson     EXPECT_EQ(Prologue.MaxOpsPerInst, 1u);
155a3acf99eSJames Henderson     break;
156a3acf99eSJames Henderson   case 2:
157a3acf99eSJames Henderson   case 3:
158a3acf99eSJames Henderson     PrologueLength = 35;
159a3acf99eSJames Henderson     UnitLength = PrologueLength + 2;
160a3acf99eSJames Henderson     break;
161a3acf99eSJames Henderson   case 5:
162a3acf99eSJames Henderson     PrologueLength = 39;
163a3acf99eSJames Henderson     UnitLength = PrologueLength + 4;
164*11a9de74SJames Henderson     EXPECT_EQ(Prologue.getAddressSize(), 8u);
165*11a9de74SJames Henderson     EXPECT_EQ(Prologue.SegSelectorSize, 0u);
166a3acf99eSJames Henderson     break;
167a3acf99eSJames Henderson   default:
168a3acf99eSJames Henderson     llvm_unreachable("unsupported DWARF version");
169a3acf99eSJames Henderson   }
170a3acf99eSJames Henderson   UnitLength += BodyLength + (Format == DWARF32 ? 4 : 8);
171a3acf99eSJames Henderson 
172a3acf99eSJames Henderson   EXPECT_EQ(Prologue.TotalLength, UnitLength);
173a3acf99eSJames Henderson   EXPECT_EQ(Prologue.PrologueLength, PrologueLength);
174*11a9de74SJames Henderson   EXPECT_EQ(Prologue.MinInstLength, 1u);
175*11a9de74SJames Henderson   EXPECT_EQ(Prologue.DefaultIsStmt, 1u);
176a3acf99eSJames Henderson   EXPECT_EQ(Prologue.LineBase, -5);
177*11a9de74SJames Henderson   EXPECT_EQ(Prologue.LineRange, 14u);
178*11a9de74SJames Henderson   EXPECT_EQ(Prologue.OpcodeBase, 13u);
179a3acf99eSJames Henderson   std::vector<uint8_t> ExpectedLengths = {0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1};
180a3acf99eSJames Henderson   EXPECT_EQ(Prologue.StandardOpcodeLengths, ExpectedLengths);
181*11a9de74SJames Henderson   ASSERT_EQ(Prologue.IncludeDirectories.size(), 1u);
182a3acf99eSJames Henderson   ASSERT_EQ(Prologue.IncludeDirectories[0].getForm(), DW_FORM_string);
183a3acf99eSJames Henderson   EXPECT_STREQ(*Prologue.IncludeDirectories[0].getAsCString(), "a dir");
184*11a9de74SJames Henderson   ASSERT_EQ(Prologue.FileNames.size(), 1u);
185a3acf99eSJames Henderson   ASSERT_EQ(Prologue.FileNames[0].Name.getForm(), DW_FORM_string);
186a3acf99eSJames Henderson   EXPECT_STREQ(*Prologue.FileNames[0].Name.getAsCString(), "a file");
187a3acf99eSJames Henderson }
188a3acf99eSJames Henderson 
189a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, GetOrParseLineTableAtInvalidOffset) {
190a3acf99eSJames Henderson   if (!setupGenerator())
191a3acf99eSJames Henderson     return;
192a3acf99eSJames Henderson   generate();
193a3acf99eSJames Henderson 
194a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError(
195a3acf99eSJames Henderson       "offset 0x00000000 is not a valid debug line section offset", 0);
196a3acf99eSJames Henderson   // Repeat to show that an error is reported each time.
197a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError(
198a3acf99eSJames Henderson       "offset 0x00000000 is not a valid debug line section offset", 0);
199a3acf99eSJames Henderson   // Show that an error is reported for later offsets too.
200a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError(
201a3acf99eSJames Henderson       "offset 0x00000001 is not a valid debug line section offset", 1);
202a3acf99eSJames Henderson }
203a3acf99eSJames Henderson 
204a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, GetOrParseLineTableAtInvalidOffsetAfterData) {
205a3acf99eSJames Henderson   if (!setupGenerator())
20666702629SJames Henderson     return;
20766702629SJames Henderson 
208a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable();
209a3acf99eSJames Henderson   LT.setCustomPrologue({{0, LineTable::Byte}});
21066702629SJames Henderson 
211a3acf99eSJames Henderson   generate();
212a3acf99eSJames Henderson 
213a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError(
214a3acf99eSJames Henderson       "offset 0x00000001 is not a valid debug line section offset", 1);
215a3acf99eSJames Henderson }
216a3acf99eSJames Henderson 
217a3acf99eSJames Henderson TEST_P(DebugLineParameterisedFixture, GetOrParseLineTableValidTable) {
218a3acf99eSJames Henderson   if (!setupGenerator(Version))
219a3acf99eSJames Henderson     return;
220a3acf99eSJames Henderson 
221a3acf99eSJames Henderson   SCOPED_TRACE("Checking Version " + std::to_string(Version) + ", Format " +
222a3acf99eSJames Henderson                (Format == DWARF64 ? "DWARF64" : "DWARF32"));
223a3acf99eSJames Henderson 
224a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable(Format);
225a3acf99eSJames Henderson   LT.addExtendedOpcode(9, DW_LNE_set_address, {{0xadd4e55, LineTable::Quad}});
226a3acf99eSJames Henderson   LT.addStandardOpcode(DW_LNS_copy, {});
227a3acf99eSJames Henderson   LT.addByte(0xaa);
228a3acf99eSJames Henderson   LT.addExtendedOpcode(1, DW_LNE_end_sequence, {});
229a3acf99eSJames Henderson 
230a3acf99eSJames Henderson   LineTable &LT2 = Gen->addLineTable(Format);
231a3acf99eSJames Henderson   LT2.addExtendedOpcode(9, DW_LNE_set_address, {{0x11223344, LineTable::Quad}});
232a3acf99eSJames Henderson   LT2.addStandardOpcode(DW_LNS_copy, {});
233a3acf99eSJames Henderson   LT2.addByte(0xbb);
234a3acf99eSJames Henderson   LT2.addExtendedOpcode(1, DW_LNE_end_sequence, {});
235a3acf99eSJames Henderson   LT2.addExtendedOpcode(9, DW_LNE_set_address, {{0x55667788, LineTable::Quad}});
236a3acf99eSJames Henderson   LT2.addStandardOpcode(DW_LNS_copy, {});
237a3acf99eSJames Henderson   LT2.addByte(0xcc);
238a3acf99eSJames Henderson   LT2.addExtendedOpcode(1, DW_LNE_end_sequence, {});
239a3acf99eSJames Henderson 
240a3acf99eSJames Henderson   generate();
241a3acf99eSJames Henderson 
242a3acf99eSJames Henderson   auto ExpectedLineTable =
243a3acf99eSJames Henderson       Line.getOrParseLineTable(LineData, 0, *Context, nullptr, RecordIssue);
244a3acf99eSJames Henderson   ASSERT_TRUE(ExpectedLineTable.operator bool());
245a3acf99eSJames Henderson   EXPECT_TRUE(IssueMessage.empty());
246a3acf99eSJames Henderson   const DWARFDebugLine::LineTable *Expected = *ExpectedLineTable;
247a3acf99eSJames Henderson   checkDefaultPrologue(Version, Format, Expected->Prologue, 16);
248a3acf99eSJames Henderson   EXPECT_EQ(Expected->Sequences.size(), 1);
249a3acf99eSJames Henderson 
250a3acf99eSJames Henderson   uint64_t SecondOffset =
251a3acf99eSJames Henderson       Expected->Prologue.sizeofTotalLength() + Expected->Prologue.TotalLength;
252a3acf99eSJames Henderson   IssueMessage.clear();
253a3acf99eSJames Henderson   auto ExpectedLineTable2 = Line.getOrParseLineTable(
254a3acf99eSJames Henderson       LineData, SecondOffset, *Context, nullptr, RecordIssue);
255a3acf99eSJames Henderson   ASSERT_TRUE(ExpectedLineTable2.operator bool());
256a3acf99eSJames Henderson   EXPECT_TRUE(IssueMessage.empty());
257a3acf99eSJames Henderson   const DWARFDebugLine::LineTable *Expected2 = *ExpectedLineTable2;
258a3acf99eSJames Henderson   checkDefaultPrologue(Version, Format, Expected2->Prologue, 32);
259*11a9de74SJames Henderson   EXPECT_EQ(Expected2->Sequences.size(), 2u);
260a3acf99eSJames Henderson 
261a3acf99eSJames Henderson   EXPECT_NE(Expected, Expected2);
262a3acf99eSJames Henderson 
263a3acf99eSJames Henderson   // Check that if the same offset is requested, the exact same pointer is
264a3acf99eSJames Henderson   // returned.
265a3acf99eSJames Henderson   IssueMessage.clear();
266a3acf99eSJames Henderson   auto ExpectedLineTable3 =
267a3acf99eSJames Henderson       Line.getOrParseLineTable(LineData, 0, *Context, nullptr, RecordIssue);
268a3acf99eSJames Henderson   ASSERT_TRUE(ExpectedLineTable3.operator bool());
269a3acf99eSJames Henderson   EXPECT_TRUE(IssueMessage.empty());
270a3acf99eSJames Henderson   EXPECT_EQ(Expected, *ExpectedLineTable3);
271a3acf99eSJames Henderson 
272a3acf99eSJames Henderson   IssueMessage.clear();
273a3acf99eSJames Henderson   auto ExpectedLineTable4 = Line.getOrParseLineTable(
274a3acf99eSJames Henderson       LineData, SecondOffset, *Context, nullptr, RecordIssue);
275a3acf99eSJames Henderson   ASSERT_TRUE(ExpectedLineTable4.operator bool());
276a3acf99eSJames Henderson   EXPECT_TRUE(IssueMessage.empty());
277a3acf99eSJames Henderson   EXPECT_EQ(Expected2, *ExpectedLineTable4);
278a3acf99eSJames Henderson 
279a3acf99eSJames Henderson   // TODO: Add tests that show that the body of the programs have been read
280a3acf99eSJames Henderson   // correctly.
281a3acf99eSJames Henderson }
282a3acf99eSJames Henderson 
283a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ErrorForReservedLength) {
284a3acf99eSJames Henderson   if (!setupGenerator())
285a3acf99eSJames Henderson     return;
286a3acf99eSJames Henderson 
287a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable();
288a3acf99eSJames Henderson   LT.setCustomPrologue({{0xffffff00, LineTable::Long}});
289a3acf99eSJames Henderson 
290a3acf99eSJames Henderson   generate();
291a3acf99eSJames Henderson 
292a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError(
293a3acf99eSJames Henderson       "parsing line table prologue at offset 0x00000000 unsupported reserved "
294a3acf99eSJames Henderson       "unit length found of value 0xffffff00");
295a3acf99eSJames Henderson }
296a3acf99eSJames Henderson 
297a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ErrorForLowVersion) {
298a3acf99eSJames Henderson   if (!setupGenerator())
299a3acf99eSJames Henderson     return;
300a3acf99eSJames Henderson 
301a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable();
302a3acf99eSJames Henderson   LT.setCustomPrologue(
303a3acf99eSJames Henderson       {{LineTable::Half, LineTable::Long}, {1, LineTable::Half}});
304a3acf99eSJames Henderson 
305a3acf99eSJames Henderson   generate();
306a3acf99eSJames Henderson 
307a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError("parsing line table prologue at offset "
308a3acf99eSJames Henderson                                      "0x00000000 found unsupported version "
309a3acf99eSJames Henderson                                      "0x01");
310a3acf99eSJames Henderson }
311a3acf99eSJames Henderson 
312a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ErrorForInvalidV5IncludeDirTable) {
313a3acf99eSJames Henderson   if (!setupGenerator(5))
314a3acf99eSJames Henderson     return;
315a3acf99eSJames Henderson 
316a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable();
317a3acf99eSJames Henderson   LT.setCustomPrologue({
318a3acf99eSJames Henderson       {19, LineTable::Long}, // unit length
319a3acf99eSJames Henderson       {5, LineTable::Half},  // version
320a3acf99eSJames Henderson       {8, LineTable::Byte},  // addr size
321a3acf99eSJames Henderson       {0, LineTable::Byte},  // segment selector size
322a3acf99eSJames Henderson       {11, LineTable::Long}, // prologue length
323a3acf99eSJames Henderson       {1, LineTable::Byte},  // min instruction length
324a3acf99eSJames Henderson       {1, LineTable::Byte},  // max ops per instruction
325a3acf99eSJames Henderson       {1, LineTable::Byte},  // default is_stmt
326a3acf99eSJames Henderson       {0, LineTable::Byte},  // line base
327a3acf99eSJames Henderson       {14, LineTable::Byte}, // line range
328a3acf99eSJames Henderson       {2, LineTable::Byte},  // opcode base (small to reduce the amount of
329a3acf99eSJames Henderson                              // setup required).
330a3acf99eSJames Henderson       {0, LineTable::Byte},  // standard opcode lengths
331a3acf99eSJames Henderson       {0, LineTable::Byte},  // directory entry format count (should not be
332a3acf99eSJames Henderson                              // zero).
333a3acf99eSJames Henderson       {0, LineTable::ULEB},  // directories count
334a3acf99eSJames Henderson       {0, LineTable::Byte},  // file name entry format count
335a3acf99eSJames Henderson       {0, LineTable::ULEB}   // file name entry count
336a3acf99eSJames Henderson   });
337a3acf99eSJames Henderson 
338a3acf99eSJames Henderson   generate();
339a3acf99eSJames Henderson 
340a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError(
341a3acf99eSJames Henderson       "parsing line table prologue at 0x00000000 found an invalid directory or "
342a3acf99eSJames Henderson       "file table description at 0x00000014");
343a3acf99eSJames Henderson }
344a3acf99eSJames Henderson 
345a3acf99eSJames Henderson TEST_P(DebugLineParameterisedFixture, ErrorForTooLargePrologueLength) {
346a3acf99eSJames Henderson   if (!setupGenerator(Version))
347a3acf99eSJames Henderson     return;
348a3acf99eSJames Henderson 
349a3acf99eSJames Henderson   SCOPED_TRACE("Checking Version " + std::to_string(Version) + ", Format " +
350a3acf99eSJames Henderson                (Format == DWARF64 ? "DWARF64" : "DWARF32"));
351a3acf99eSJames Henderson 
352a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable(Format);
353a3acf99eSJames Henderson   DWARFDebugLine::Prologue Prologue = LT.createBasicPrologue();
354a3acf99eSJames Henderson   ++Prologue.PrologueLength;
355a3acf99eSJames Henderson   LT.setPrologue(Prologue);
356a3acf99eSJames Henderson 
357a3acf99eSJames Henderson   generate();
358a3acf99eSJames Henderson 
359a3acf99eSJames Henderson   uint64_t ExpectedEnd =
360a3acf99eSJames Henderson       Prologue.TotalLength + 1 + Prologue.sizeofTotalLength();
361a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError(
362a3acf99eSJames Henderson       (Twine("parsing line table prologue at 0x00000000 should have ended at "
363a3acf99eSJames Henderson              "0x000000") +
364a3acf99eSJames Henderson        Twine::utohexstr(ExpectedEnd) + " but it ended at 0x000000" +
365a3acf99eSJames Henderson        Twine::utohexstr(ExpectedEnd - 1))
366a3acf99eSJames Henderson           .str());
367a3acf99eSJames Henderson }
368a3acf99eSJames Henderson 
369a3acf99eSJames Henderson TEST_P(DebugLineParameterisedFixture, ErrorForTooShortPrologueLength) {
370a3acf99eSJames Henderson   if (!setupGenerator(Version))
371a3acf99eSJames Henderson     return;
372a3acf99eSJames Henderson 
373a3acf99eSJames Henderson   SCOPED_TRACE("Checking Version " + std::to_string(Version) + ", Format " +
374a3acf99eSJames Henderson                (Format == DWARF64 ? "DWARF64" : "DWARF32"));
375a3acf99eSJames Henderson 
376a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable(Format);
377a3acf99eSJames Henderson   DWARFDebugLine::Prologue Prologue = LT.createBasicPrologue();
378a3acf99eSJames Henderson   // FIXME: Ideally, we'd test for 1 less than expected, but the code does not
379a3acf99eSJames Henderson   // currently fail if missing only the terminator of a v2-4 file table.
380a3acf99eSJames Henderson   if (Version < 5)
381a3acf99eSJames Henderson     Prologue.PrologueLength -= 2;
382a3acf99eSJames Henderson   else
383a3acf99eSJames Henderson     Prologue.PrologueLength -= 1;
384a3acf99eSJames Henderson   LT.setPrologue(Prologue);
385a3acf99eSJames Henderson 
386a3acf99eSJames Henderson   generate();
387a3acf99eSJames Henderson 
388a3acf99eSJames Henderson   uint64_t ExpectedEnd =
389a3acf99eSJames Henderson       Prologue.TotalLength - 1 + Prologue.sizeofTotalLength();
390a3acf99eSJames Henderson   if (Version < 5)
391a3acf99eSJames Henderson     --ExpectedEnd;
392a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError(
393a3acf99eSJames Henderson       (Twine("parsing line table prologue at 0x00000000 should have ended at "
394a3acf99eSJames Henderson              "0x000000") +
395a3acf99eSJames Henderson        Twine::utohexstr(ExpectedEnd) + " but it ended at 0x000000" +
396a3acf99eSJames Henderson        Twine::utohexstr(ExpectedEnd + 1))
397a3acf99eSJames Henderson           .str());
398a3acf99eSJames Henderson }
399a3acf99eSJames Henderson 
400a3acf99eSJames Henderson INSTANTIATE_TEST_CASE_P(
401a3acf99eSJames Henderson     LineTableTestParams, DebugLineParameterisedFixture,
402a3acf99eSJames Henderson     Values(std::make_pair(
403a3acf99eSJames Henderson                2, DWARF32), // Test lower-bound of v2-3 fields and DWARF32.
404a3acf99eSJames Henderson            std::make_pair(3, DWARF32), // Test upper-bound of v2-3 fields.
405a3acf99eSJames Henderson            std::make_pair(4, DWARF64), // Test v4 fields and DWARF64.
406a3acf99eSJames Henderson            std::make_pair(5, DWARF32), std::make_pair(5, DWARF64)),);
407a3acf99eSJames Henderson 
408a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ErrorForInvalidExtendedOpcodeLength) {
409a3acf99eSJames Henderson   if (!setupGenerator())
410a3acf99eSJames Henderson     return;
411a3acf99eSJames Henderson 
412a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable();
413a3acf99eSJames Henderson   // The Length should be 1 for an end sequence opcode.
414a3acf99eSJames Henderson   LT.addExtendedOpcode(2, DW_LNE_end_sequence, {});
415a3acf99eSJames Henderson 
416a3acf99eSJames Henderson   generate();
417a3acf99eSJames Henderson 
418a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError("unexpected line op length at offset "
419a3acf99eSJames Henderson                                      "0x00000030 expected 0x02 found 0x01");
420a3acf99eSJames Henderson }
421a3acf99eSJames Henderson 
422a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ErrorForMismatchedAddressSize) {
423a3acf99eSJames Henderson   if (!setupGenerator())
424a3acf99eSJames Henderson     return;
425a3acf99eSJames Henderson 
426a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable();
427a3acf99eSJames Henderson   // The line data extractor expects size 8 (Quad) addresses.
428a3acf99eSJames Henderson   LT.addExtendedOpcode(5, DW_LNE_set_address, {{0x11223344, LineTable::Long}});
429a3acf99eSJames Henderson   LT.addStandardOpcode(DW_LNS_copy, {});
430a3acf99eSJames Henderson   LT.addByte(0xaa);
431a3acf99eSJames Henderson   LT.addExtendedOpcode(1, DW_LNE_end_sequence, {});
432a3acf99eSJames Henderson 
433a3acf99eSJames Henderson   generate();
434a3acf99eSJames Henderson 
435a3acf99eSJames Henderson   checkGetOrParseLineTableEmitsError(
436a3acf99eSJames Henderson       "mismatching address size at offset 0x00000030 expected 0x08 found 0x04");
437a3acf99eSJames Henderson }
438a3acf99eSJames Henderson 
439a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, CallbackUsedForUnterminatedSequence) {
440a3acf99eSJames Henderson   if (!setupGenerator())
441a3acf99eSJames Henderson     return;
442a3acf99eSJames Henderson 
443a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable();
444a3acf99eSJames Henderson   LT.addExtendedOpcode(9, DW_LNE_set_address,
445a3acf99eSJames Henderson                        {{0x1122334455667788, LineTable::Quad}});
446a3acf99eSJames Henderson   LT.addStandardOpcode(DW_LNS_copy, {});
447a3acf99eSJames Henderson   LT.addByte(0xaa);
448a3acf99eSJames Henderson   LT.addExtendedOpcode(1, DW_LNE_end_sequence, {});
449a3acf99eSJames Henderson   LT.addExtendedOpcode(9, DW_LNE_set_address,
450a3acf99eSJames Henderson                        {{0x99aabbccddeeff00, LineTable::Quad}});
451a3acf99eSJames Henderson   LT.addStandardOpcode(DW_LNS_copy, {});
452a3acf99eSJames Henderson   LT.addByte(0xbb);
453a3acf99eSJames Henderson   LT.addByte(0xcc);
454a3acf99eSJames Henderson 
455a3acf99eSJames Henderson   generate();
456a3acf99eSJames Henderson 
457a3acf99eSJames Henderson   auto ExpectedLineTable =
458a3acf99eSJames Henderson       Line.getOrParseLineTable(LineData, 0, *Context, nullptr, RecordIssue);
459a3acf99eSJames Henderson   EXPECT_EQ(IssueMessage,
460a3acf99eSJames Henderson             "last sequence in debug line table is not terminated!");
461a3acf99eSJames Henderson   ASSERT_TRUE(ExpectedLineTable.operator bool());
462a3acf99eSJames Henderson   EXPECT_EQ((*ExpectedLineTable)->Rows.size(), 6);
463a3acf99eSJames Henderson   // The unterminated sequence is not added to the sequence list.
464a3acf99eSJames Henderson   EXPECT_EQ((*ExpectedLineTable)->Sequences.size(), 1);
465a3acf99eSJames Henderson }
466a3acf99eSJames Henderson 
467a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ParserParsesCorrectly) {
468a3acf99eSJames Henderson   if (!setupGenerator())
469a3acf99eSJames Henderson     return;
470a3acf99eSJames Henderson 
471a3acf99eSJames Henderson   DWARFDebugLine::SectionParser Parser = setupParser();
472a3acf99eSJames Henderson 
473*11a9de74SJames Henderson   EXPECT_EQ(Parser.getOffset(), 0u);
474a3acf99eSJames Henderson   ASSERT_FALSE(Parser.done());
475a3acf99eSJames Henderson 
476a3acf99eSJames Henderson   DWARFDebugLine::LineTable Parsed = Parser.parseNext(RecordIssue, RecordError);
477a3acf99eSJames Henderson   checkDefaultPrologue(4, DWARF32, Parsed.Prologue, 16);
478*11a9de74SJames Henderson   EXPECT_EQ(Parsed.Sequences.size(), 1u);
479*11a9de74SJames Henderson   EXPECT_EQ(Parser.getOffset(), 62u);
480a3acf99eSJames Henderson   ASSERT_FALSE(Parser.done());
481a3acf99eSJames Henderson 
482a3acf99eSJames Henderson   DWARFDebugLine::LineTable Parsed2 =
483a3acf99eSJames Henderson       Parser.parseNext(RecordIssue, RecordError);
484a3acf99eSJames Henderson   checkDefaultPrologue(4, DWARF64, Parsed2.Prologue, 16);
485*11a9de74SJames Henderson   EXPECT_EQ(Parsed2.Sequences.size(), 1u);
486*11a9de74SJames Henderson   EXPECT_EQ(Parser.getOffset(), 136u);
487a3acf99eSJames Henderson   EXPECT_TRUE(Parser.done());
488a3acf99eSJames Henderson 
489a3acf99eSJames Henderson   EXPECT_TRUE(IssueMessage.empty());
490a3acf99eSJames Henderson   EXPECT_FALSE(FoundError);
491a3acf99eSJames Henderson }
492a3acf99eSJames Henderson 
493a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ParserSkipsCorrectly) {
494a3acf99eSJames Henderson   if (!setupGenerator())
495a3acf99eSJames Henderson     return;
496a3acf99eSJames Henderson 
497a3acf99eSJames Henderson   DWARFDebugLine::SectionParser Parser = setupParser();
498a3acf99eSJames Henderson 
499*11a9de74SJames Henderson   EXPECT_EQ(Parser.getOffset(), 0u);
500a3acf99eSJames Henderson   ASSERT_FALSE(Parser.done());
501a3acf99eSJames Henderson 
502a3acf99eSJames Henderson   Parser.skip(RecordError);
503*11a9de74SJames Henderson   EXPECT_EQ(Parser.getOffset(), 62u);
504a3acf99eSJames Henderson   ASSERT_FALSE(Parser.done());
505a3acf99eSJames Henderson 
506a3acf99eSJames Henderson   Parser.skip(RecordError);
507*11a9de74SJames Henderson   EXPECT_EQ(Parser.getOffset(), 136u);
508a3acf99eSJames Henderson   EXPECT_TRUE(Parser.done());
509a3acf99eSJames Henderson 
510a3acf99eSJames Henderson   EXPECT_FALSE(FoundError);
511a3acf99eSJames Henderson }
512a3acf99eSJames Henderson 
513a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ParserAlwaysDoneForEmptySection) {
514a3acf99eSJames Henderson   if (!setupGenerator())
515a3acf99eSJames Henderson     return;
516a3acf99eSJames Henderson 
517a3acf99eSJames Henderson   generate();
518a3acf99eSJames Henderson   DWARFDebugLine::SectionParser Parser(LineData, *Context, CUs, TUs);
519a3acf99eSJames Henderson 
520a3acf99eSJames Henderson   EXPECT_TRUE(Parser.done());
521a3acf99eSJames Henderson }
522a3acf99eSJames Henderson 
523a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ParserMovesToEndForBadLengthWhenParsing) {
524a3acf99eSJames Henderson   if (!setupGenerator())
525a3acf99eSJames Henderson     return;
526a3acf99eSJames Henderson 
527a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable();
528a3acf99eSJames Henderson   LT.setCustomPrologue({{0xffffff00, LineTable::Long}});
529a3acf99eSJames Henderson   Gen->addLineTable();
530a3acf99eSJames Henderson   generate();
531a3acf99eSJames Henderson 
532a3acf99eSJames Henderson   DWARFDebugLine::SectionParser Parser(LineData, *Context, CUs, TUs);
533a3acf99eSJames Henderson   Parser.parseNext(RecordIssue, RecordError);
534a3acf99eSJames Henderson 
535*11a9de74SJames Henderson   EXPECT_EQ(Parser.getOffset(), 4u);
536a3acf99eSJames Henderson   EXPECT_TRUE(Parser.done());
537a3acf99eSJames Henderson   EXPECT_TRUE(IssueMessage.empty());
538a3acf99eSJames Henderson 
539a3acf99eSJames Henderson   checkError("parsing line table prologue at offset 0x00000000 unsupported "
540a3acf99eSJames Henderson              "reserved unit length found of value 0xffffff00",
541a3acf99eSJames Henderson              std::move(FoundError));
542a3acf99eSJames Henderson }
543a3acf99eSJames Henderson 
544a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ParserMovesToEndForBadLengthWhenSkipping) {
545a3acf99eSJames Henderson   if (!setupGenerator())
546a3acf99eSJames Henderson     return;
547a3acf99eSJames Henderson 
548a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable();
549a3acf99eSJames Henderson   LT.setCustomPrologue({{0xffffff00, LineTable::Long}});
550a3acf99eSJames Henderson   Gen->addLineTable();
551a3acf99eSJames Henderson   generate();
552a3acf99eSJames Henderson 
553a3acf99eSJames Henderson   DWARFDebugLine::SectionParser Parser(LineData, *Context, CUs, TUs);
554a3acf99eSJames Henderson   Parser.skip(RecordError);
555a3acf99eSJames Henderson 
556*11a9de74SJames Henderson   EXPECT_EQ(Parser.getOffset(), 4u);
557a3acf99eSJames Henderson   EXPECT_TRUE(Parser.done());
558a3acf99eSJames Henderson 
559a3acf99eSJames Henderson   checkError("parsing line table prologue at offset 0x00000000 unsupported "
560a3acf99eSJames Henderson              "reserved unit length found of value 0xffffff00",
561a3acf99eSJames Henderson              std::move(FoundError));
562a3acf99eSJames Henderson }
563a3acf99eSJames Henderson 
564a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ParserReportsFirstErrorInEachTableWhenParsing) {
565a3acf99eSJames Henderson   if (!setupGenerator())
566a3acf99eSJames Henderson     return;
567a3acf99eSJames Henderson 
568a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable(DWARF32);
569a3acf99eSJames Henderson   LT.setCustomPrologue({{2, LineTable::Long}, {0, LineTable::Half}});
570a3acf99eSJames Henderson   LineTable &LT2 = Gen->addLineTable(DWARF32);
571a3acf99eSJames Henderson   LT2.setCustomPrologue({{2, LineTable::Long}, {1, LineTable::Half}});
572a3acf99eSJames Henderson   generate();
573a3acf99eSJames Henderson 
574a3acf99eSJames Henderson   DWARFDebugLine::SectionParser Parser(LineData, *Context, CUs, TUs);
575a3acf99eSJames Henderson   Parser.parseNext(RecordIssue, RecordError);
576a3acf99eSJames Henderson   ASSERT_FALSE(Parser.done());
577a3acf99eSJames Henderson   Parser.parseNext(RecordIssue, RecordError);
578a3acf99eSJames Henderson 
579a3acf99eSJames Henderson   EXPECT_TRUE(Parser.done());
580a3acf99eSJames Henderson   EXPECT_TRUE(IssueMessage.empty());
581a3acf99eSJames Henderson 
582a3acf99eSJames Henderson   checkError({"parsing line table prologue at offset 0x00000000 found "
583a3acf99eSJames Henderson               "unsupported version 0x00",
584a3acf99eSJames Henderson               "parsing line table prologue at offset 0x00000006 found "
585a3acf99eSJames Henderson               "unsupported version 0x01"},
586a3acf99eSJames Henderson              std::move(FoundError));
587a3acf99eSJames Henderson }
588a3acf99eSJames Henderson 
589a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ParserReportsNonPrologueProblemsWhenParsing) {
590a3acf99eSJames Henderson   if (!setupGenerator())
591a3acf99eSJames Henderson     return;
592a3acf99eSJames Henderson 
593a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable(DWARF32);
594a3acf99eSJames Henderson   LT.addExtendedOpcode(0x42, DW_LNE_end_sequence, {});
595a3acf99eSJames Henderson   LineTable &LT2 = Gen->addLineTable(DWARF32);
596a3acf99eSJames Henderson   LT2.addExtendedOpcode(9, DW_LNE_set_address,
597a3acf99eSJames Henderson                         {{0x1234567890abcdef, LineTable::Quad}});
598a3acf99eSJames Henderson   LT2.addStandardOpcode(DW_LNS_copy, {});
599a3acf99eSJames Henderson   LT2.addByte(0xbb);
600a3acf99eSJames Henderson   generate();
601a3acf99eSJames Henderson 
602a3acf99eSJames Henderson   DWARFDebugLine::SectionParser Parser(LineData, *Context, CUs, TUs);
603a3acf99eSJames Henderson   Parser.parseNext(RecordIssue, RecordError);
604a3acf99eSJames Henderson   EXPECT_TRUE(IssueMessage.empty());
605a3acf99eSJames Henderson   ASSERT_FALSE(Parser.done());
606a3acf99eSJames Henderson   checkError(
607a3acf99eSJames Henderson       "unexpected line op length at offset 0x00000030 expected 0x42 found 0x01",
608a3acf99eSJames Henderson       std::move(FoundError));
609a3acf99eSJames Henderson 
610a3acf99eSJames Henderson   // Reset the error state so that it does not confuse the next set of checks.
611a3acf99eSJames Henderson   FoundError = Error::success();
612a3acf99eSJames Henderson   Parser.parseNext(RecordIssue, RecordError);
613a3acf99eSJames Henderson 
614a3acf99eSJames Henderson   EXPECT_TRUE(Parser.done());
615a3acf99eSJames Henderson   EXPECT_EQ(IssueMessage,
616a3acf99eSJames Henderson             "last sequence in debug line table is not terminated!");
617a3acf99eSJames Henderson   EXPECT_TRUE(!FoundError);
618a3acf99eSJames Henderson }
619a3acf99eSJames Henderson 
620a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture,
621a3acf99eSJames Henderson        ParserReportsPrologueErrorsInEachTableWhenSkipping) {
622a3acf99eSJames Henderson   if (!setupGenerator())
623a3acf99eSJames Henderson     return;
624a3acf99eSJames Henderson 
625a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable(DWARF32);
626a3acf99eSJames Henderson   LT.setCustomPrologue({{2, LineTable::Long}, {0, LineTable::Half}});
627a3acf99eSJames Henderson   LineTable &LT2 = Gen->addLineTable(DWARF32);
628a3acf99eSJames Henderson   LT2.setCustomPrologue({{2, LineTable::Long}, {1, LineTable::Half}});
629a3acf99eSJames Henderson   generate();
630a3acf99eSJames Henderson 
631a3acf99eSJames Henderson   DWARFDebugLine::SectionParser Parser(LineData, *Context, CUs, TUs);
632a3acf99eSJames Henderson   Parser.skip(RecordError);
633a3acf99eSJames Henderson   ASSERT_FALSE(Parser.done());
634a3acf99eSJames Henderson   Parser.skip(RecordError);
635a3acf99eSJames Henderson 
636a3acf99eSJames Henderson   EXPECT_TRUE(Parser.done());
637a3acf99eSJames Henderson 
638a3acf99eSJames Henderson   checkError({"parsing line table prologue at offset 0x00000000 found "
639a3acf99eSJames Henderson               "unsupported version 0x00",
640a3acf99eSJames Henderson               "parsing line table prologue at offset 0x00000006 found "
641a3acf99eSJames Henderson               "unsupported version 0x01"},
642a3acf99eSJames Henderson              std::move(FoundError));
643a3acf99eSJames Henderson }
644a3acf99eSJames Henderson 
645a3acf99eSJames Henderson TEST_F(DebugLineBasicFixture, ParserIgnoresNonPrologueErrorsWhenSkipping) {
646a3acf99eSJames Henderson   if (!setupGenerator())
647a3acf99eSJames Henderson     return;
648a3acf99eSJames Henderson 
649a3acf99eSJames Henderson   LineTable &LT = Gen->addLineTable(DWARF32);
650a3acf99eSJames Henderson   LT.addExtendedOpcode(42, DW_LNE_end_sequence, {});
651a3acf99eSJames Henderson   generate();
652a3acf99eSJames Henderson 
653a3acf99eSJames Henderson   DWARFDebugLine::SectionParser Parser(LineData, *Context, CUs, TUs);
654a3acf99eSJames Henderson   Parser.skip(RecordError);
655a3acf99eSJames Henderson 
656a3acf99eSJames Henderson   EXPECT_TRUE(Parser.done());
657a3acf99eSJames Henderson   EXPECT_TRUE(!FoundError);
65866702629SJames Henderson }
65966702629SJames Henderson 
66066702629SJames Henderson } // end anonymous namespace
661