1 //===- llvm/unittest/DebugInfo/DWARFDebugInfoTest.cpp ---------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "DwarfGenerator.h" 10 #include "DwarfUtils.h" 11 #include "llvm/ADT/ArrayRef.h" 12 #include "llvm/ADT/Optional.h" 13 #include "llvm/ADT/SmallString.h" 14 #include "llvm/ADT/StringRef.h" 15 #include "llvm/ADT/Triple.h" 16 #include "llvm/BinaryFormat/Dwarf.h" 17 #include "llvm/CodeGen/AsmPrinter.h" 18 #include "llvm/DebugInfo/DWARF/DWARFCompileUnit.h" 19 #include "llvm/DebugInfo/DWARF/DWARFContext.h" 20 #include "llvm/DebugInfo/DWARF/DWARFDie.h" 21 #include "llvm/DebugInfo/DWARF/DWARFFormValue.h" 22 #include "llvm/DebugInfo/DWARF/DWARFVerifier.h" 23 #include "llvm/MC/MCContext.h" 24 #include "llvm/MC/MCSectionELF.h" 25 #include "llvm/MC/MCStreamer.h" 26 #include "llvm/Object/ObjectFile.h" 27 #include "llvm/ObjectYAML/DWARFEmitter.h" 28 #include "llvm/Support/Error.h" 29 #include "llvm/Support/MemoryBuffer.h" 30 #include "llvm/Support/TargetRegistry.h" 31 #include "llvm/Support/TargetSelect.h" 32 #include "llvm/Testing/Support/Error.h" 33 #include "gtest/gtest.h" 34 #include <string> 35 36 using namespace llvm; 37 using namespace dwarf; 38 using namespace utils; 39 40 namespace { 41 42 template <uint16_t Version, class AddrType, class RefAddrType> 43 void TestAllForms() { 44 Triple Triple = getDefaultTargetTripleForAddrSize(sizeof(AddrType)); 45 if (!isConfigurationSupported(Triple)) 46 return; 47 48 // Test that we can decode all DW_FORM values correctly. 49 const AddrType AddrValue = (AddrType)0x0123456789abcdefULL; 50 const uint8_t BlockData[] = {1, 2, 3, 4, 5, 6, 7, 8, 9, 0}; 51 const uint32_t BlockSize = sizeof(BlockData); 52 const RefAddrType RefAddr = 0x12345678; 53 const uint8_t Data1 = 0x01U; 54 const uint16_t Data2 = 0x2345U; 55 const uint32_t Data4 = 0x6789abcdU; 56 const uint64_t Data8 = 0x0011223344556677ULL; 57 const uint64_t Data8_2 = 0xAABBCCDDEEFF0011ULL; 58 const uint8_t Data16[16] = {1, 2, 3, 4, 5, 6, 7, 8, 59 9, 10, 11, 12, 13, 14, 15, 16}; 60 const int64_t SData = INT64_MIN; 61 const int64_t ICSData = INT64_MAX; // DW_FORM_implicit_const SData 62 const uint64_t UData[] = {UINT64_MAX - 1, UINT64_MAX - 2, UINT64_MAX - 3, 63 UINT64_MAX - 4, UINT64_MAX - 5, UINT64_MAX - 6, 64 UINT64_MAX - 7, UINT64_MAX - 8, UINT64_MAX - 9}; 65 #define UDATA_1 18446744073709551614ULL 66 const uint32_t Dwarf32Values[] = {1, 2, 3, 4, 5, 6, 7, 8}; 67 const char *StringValue = "Hello"; 68 const char *StrpValue = "World"; 69 const char *StrxValue = "Indexed"; 70 const char *Strx1Value = "Indexed1"; 71 const char *Strx2Value = "Indexed2"; 72 const char *Strx3Value = "Indexed3"; 73 const char *Strx4Value = "Indexed4"; 74 75 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 76 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 77 dwarfgen::Generator *DG = ExpectedDG.get().get(); 78 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 79 dwarfgen::DIE CUDie = CU.getUnitDIE(); 80 81 if (Version >= 5) 82 CUDie.addStrOffsetsBaseAttribute(); 83 84 uint16_t Attr = DW_AT_lo_user; 85 86 //---------------------------------------------------------------------- 87 // Test address forms 88 //---------------------------------------------------------------------- 89 const auto Attr_DW_FORM_addr = static_cast<dwarf::Attribute>(Attr++); 90 CUDie.addAttribute(Attr_DW_FORM_addr, DW_FORM_addr, AddrValue); 91 92 //---------------------------------------------------------------------- 93 // Test block forms 94 //---------------------------------------------------------------------- 95 const auto Attr_DW_FORM_block = static_cast<dwarf::Attribute>(Attr++); 96 CUDie.addAttribute(Attr_DW_FORM_block, DW_FORM_block, BlockData, BlockSize); 97 98 const auto Attr_DW_FORM_block1 = static_cast<dwarf::Attribute>(Attr++); 99 CUDie.addAttribute(Attr_DW_FORM_block1, DW_FORM_block1, BlockData, BlockSize); 100 101 const auto Attr_DW_FORM_block2 = static_cast<dwarf::Attribute>(Attr++); 102 CUDie.addAttribute(Attr_DW_FORM_block2, DW_FORM_block2, BlockData, BlockSize); 103 104 const auto Attr_DW_FORM_block4 = static_cast<dwarf::Attribute>(Attr++); 105 CUDie.addAttribute(Attr_DW_FORM_block4, DW_FORM_block4, BlockData, BlockSize); 106 107 // We handle data16 as a block form. 108 const auto Attr_DW_FORM_data16 = static_cast<dwarf::Attribute>(Attr++); 109 if (Version >= 5) 110 CUDie.addAttribute(Attr_DW_FORM_data16, DW_FORM_data16, Data16, 16); 111 112 //---------------------------------------------------------------------- 113 // Test data forms 114 //---------------------------------------------------------------------- 115 const auto Attr_DW_FORM_data1 = static_cast<dwarf::Attribute>(Attr++); 116 CUDie.addAttribute(Attr_DW_FORM_data1, DW_FORM_data1, Data1); 117 118 const auto Attr_DW_FORM_data2 = static_cast<dwarf::Attribute>(Attr++); 119 CUDie.addAttribute(Attr_DW_FORM_data2, DW_FORM_data2, Data2); 120 121 const auto Attr_DW_FORM_data4 = static_cast<dwarf::Attribute>(Attr++); 122 CUDie.addAttribute(Attr_DW_FORM_data4, DW_FORM_data4, Data4); 123 124 const auto Attr_DW_FORM_data8 = static_cast<dwarf::Attribute>(Attr++); 125 CUDie.addAttribute(Attr_DW_FORM_data8, DW_FORM_data8, Data8); 126 127 //---------------------------------------------------------------------- 128 // Test string forms 129 //---------------------------------------------------------------------- 130 const auto Attr_DW_FORM_string = static_cast<dwarf::Attribute>(Attr++); 131 CUDie.addAttribute(Attr_DW_FORM_string, DW_FORM_string, StringValue); 132 133 const auto Attr_DW_FORM_strx = static_cast<dwarf::Attribute>(Attr++); 134 const auto Attr_DW_FORM_strx1 = static_cast<dwarf::Attribute>(Attr++); 135 const auto Attr_DW_FORM_strx2 = static_cast<dwarf::Attribute>(Attr++); 136 const auto Attr_DW_FORM_strx3 = static_cast<dwarf::Attribute>(Attr++); 137 const auto Attr_DW_FORM_strx4 = static_cast<dwarf::Attribute>(Attr++); 138 if (Version >= 5) { 139 CUDie.addAttribute(Attr_DW_FORM_strx, DW_FORM_strx, StrxValue); 140 CUDie.addAttribute(Attr_DW_FORM_strx1, DW_FORM_strx1, Strx1Value); 141 CUDie.addAttribute(Attr_DW_FORM_strx2, DW_FORM_strx2, Strx2Value); 142 CUDie.addAttribute(Attr_DW_FORM_strx3, DW_FORM_strx3, Strx3Value); 143 CUDie.addAttribute(Attr_DW_FORM_strx4, DW_FORM_strx4, Strx4Value); 144 } 145 146 const auto Attr_DW_FORM_strp = static_cast<dwarf::Attribute>(Attr++); 147 CUDie.addAttribute(Attr_DW_FORM_strp, DW_FORM_strp, StrpValue); 148 149 //---------------------------------------------------------------------- 150 // Test reference forms 151 //---------------------------------------------------------------------- 152 const auto Attr_DW_FORM_ref_addr = static_cast<dwarf::Attribute>(Attr++); 153 CUDie.addAttribute(Attr_DW_FORM_ref_addr, DW_FORM_ref_addr, RefAddr); 154 155 const auto Attr_DW_FORM_ref1 = static_cast<dwarf::Attribute>(Attr++); 156 CUDie.addAttribute(Attr_DW_FORM_ref1, DW_FORM_ref1, Data1); 157 158 const auto Attr_DW_FORM_ref2 = static_cast<dwarf::Attribute>(Attr++); 159 CUDie.addAttribute(Attr_DW_FORM_ref2, DW_FORM_ref2, Data2); 160 161 const auto Attr_DW_FORM_ref4 = static_cast<dwarf::Attribute>(Attr++); 162 CUDie.addAttribute(Attr_DW_FORM_ref4, DW_FORM_ref4, Data4); 163 164 const auto Attr_DW_FORM_ref8 = static_cast<dwarf::Attribute>(Attr++); 165 CUDie.addAttribute(Attr_DW_FORM_ref8, DW_FORM_ref8, Data8); 166 167 const auto Attr_DW_FORM_ref_sig8 = static_cast<dwarf::Attribute>(Attr++); 168 if (Version >= 4) 169 CUDie.addAttribute(Attr_DW_FORM_ref_sig8, DW_FORM_ref_sig8, Data8_2); 170 171 const auto Attr_DW_FORM_ref_udata = static_cast<dwarf::Attribute>(Attr++); 172 CUDie.addAttribute(Attr_DW_FORM_ref_udata, DW_FORM_ref_udata, UData[0]); 173 174 //---------------------------------------------------------------------- 175 // Test flag forms 176 //---------------------------------------------------------------------- 177 const auto Attr_DW_FORM_flag_true = static_cast<dwarf::Attribute>(Attr++); 178 CUDie.addAttribute(Attr_DW_FORM_flag_true, DW_FORM_flag, true); 179 180 const auto Attr_DW_FORM_flag_false = static_cast<dwarf::Attribute>(Attr++); 181 CUDie.addAttribute(Attr_DW_FORM_flag_false, DW_FORM_flag, false); 182 183 const auto Attr_DW_FORM_flag_present = static_cast<dwarf::Attribute>(Attr++); 184 if (Version >= 4) 185 CUDie.addAttribute(Attr_DW_FORM_flag_present, DW_FORM_flag_present); 186 187 //---------------------------------------------------------------------- 188 // Test SLEB128 based forms 189 //---------------------------------------------------------------------- 190 const auto Attr_DW_FORM_sdata = static_cast<dwarf::Attribute>(Attr++); 191 CUDie.addAttribute(Attr_DW_FORM_sdata, DW_FORM_sdata, SData); 192 193 const auto Attr_DW_FORM_implicit_const = 194 static_cast<dwarf::Attribute>(Attr++); 195 if (Version >= 5) 196 CUDie.addAttribute(Attr_DW_FORM_implicit_const, DW_FORM_implicit_const, 197 ICSData); 198 199 //---------------------------------------------------------------------- 200 // Test ULEB128 based forms 201 //---------------------------------------------------------------------- 202 const auto Attr_DW_FORM_udata = static_cast<dwarf::Attribute>(Attr++); 203 CUDie.addAttribute(Attr_DW_FORM_udata, DW_FORM_udata, UData[0]); 204 205 //---------------------------------------------------------------------- 206 // Test DWARF32/DWARF64 forms 207 //---------------------------------------------------------------------- 208 const auto Attr_DW_FORM_GNU_ref_alt = static_cast<dwarf::Attribute>(Attr++); 209 CUDie.addAttribute(Attr_DW_FORM_GNU_ref_alt, DW_FORM_GNU_ref_alt, 210 Dwarf32Values[0]); 211 212 const auto Attr_DW_FORM_sec_offset = static_cast<dwarf::Attribute>(Attr++); 213 if (Version >= 4) 214 CUDie.addAttribute(Attr_DW_FORM_sec_offset, DW_FORM_sec_offset, 215 Dwarf32Values[1]); 216 217 //---------------------------------------------------------------------- 218 // Add an address at the end to make sure we can decode this value 219 //---------------------------------------------------------------------- 220 const auto Attr_Last = static_cast<dwarf::Attribute>(Attr++); 221 CUDie.addAttribute(Attr_Last, DW_FORM_addr, AddrValue); 222 223 //---------------------------------------------------------------------- 224 // Generate the DWARF 225 //---------------------------------------------------------------------- 226 StringRef FileBytes = DG->generate(); 227 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 228 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 229 EXPECT_TRUE((bool)Obj); 230 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 231 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 232 EXPECT_EQ(NumCUs, 1u); 233 DWARFCompileUnit *U = 234 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 235 auto DieDG = U->getUnitDIE(false); 236 EXPECT_TRUE(DieDG.isValid()); 237 238 //---------------------------------------------------------------------- 239 // Test address forms 240 //---------------------------------------------------------------------- 241 EXPECT_EQ(AddrValue, toAddress(DieDG.find(Attr_DW_FORM_addr), 0)); 242 243 //---------------------------------------------------------------------- 244 // Test block forms 245 //---------------------------------------------------------------------- 246 Optional<DWARFFormValue> FormValue; 247 ArrayRef<uint8_t> ExtractedBlockData; 248 Optional<ArrayRef<uint8_t>> BlockDataOpt; 249 250 FormValue = DieDG.find(Attr_DW_FORM_block); 251 EXPECT_TRUE((bool)FormValue); 252 BlockDataOpt = FormValue->getAsBlock(); 253 EXPECT_TRUE(BlockDataOpt.hasValue()); 254 ExtractedBlockData = BlockDataOpt.getValue(); 255 EXPECT_EQ(ExtractedBlockData.size(), BlockSize); 256 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), BlockData, BlockSize) == 0); 257 258 FormValue = DieDG.find(Attr_DW_FORM_block1); 259 EXPECT_TRUE((bool)FormValue); 260 BlockDataOpt = FormValue->getAsBlock(); 261 EXPECT_TRUE(BlockDataOpt.hasValue()); 262 ExtractedBlockData = BlockDataOpt.getValue(); 263 EXPECT_EQ(ExtractedBlockData.size(), BlockSize); 264 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), BlockData, BlockSize) == 0); 265 266 FormValue = DieDG.find(Attr_DW_FORM_block2); 267 EXPECT_TRUE((bool)FormValue); 268 BlockDataOpt = FormValue->getAsBlock(); 269 EXPECT_TRUE(BlockDataOpt.hasValue()); 270 ExtractedBlockData = BlockDataOpt.getValue(); 271 EXPECT_EQ(ExtractedBlockData.size(), BlockSize); 272 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), BlockData, BlockSize) == 0); 273 274 FormValue = DieDG.find(Attr_DW_FORM_block4); 275 EXPECT_TRUE((bool)FormValue); 276 BlockDataOpt = FormValue->getAsBlock(); 277 EXPECT_TRUE(BlockDataOpt.hasValue()); 278 ExtractedBlockData = BlockDataOpt.getValue(); 279 EXPECT_EQ(ExtractedBlockData.size(), BlockSize); 280 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), BlockData, BlockSize) == 0); 281 282 // Data16 is handled like a block. 283 if (Version >= 5) { 284 FormValue = DieDG.find(Attr_DW_FORM_data16); 285 EXPECT_TRUE((bool)FormValue); 286 BlockDataOpt = FormValue->getAsBlock(); 287 EXPECT_TRUE(BlockDataOpt.hasValue()); 288 ExtractedBlockData = BlockDataOpt.getValue(); 289 EXPECT_EQ(ExtractedBlockData.size(), 16u); 290 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), Data16, 16) == 0); 291 } 292 293 //---------------------------------------------------------------------- 294 // Test data forms 295 //---------------------------------------------------------------------- 296 EXPECT_EQ(Data1, toUnsigned(DieDG.find(Attr_DW_FORM_data1), 0)); 297 EXPECT_EQ(Data2, toUnsigned(DieDG.find(Attr_DW_FORM_data2), 0)); 298 EXPECT_EQ(Data4, toUnsigned(DieDG.find(Attr_DW_FORM_data4), 0)); 299 EXPECT_EQ(Data8, toUnsigned(DieDG.find(Attr_DW_FORM_data8), 0)); 300 301 //---------------------------------------------------------------------- 302 // Test string forms 303 //---------------------------------------------------------------------- 304 auto ExtractedStringValue = toString(DieDG.find(Attr_DW_FORM_string)); 305 EXPECT_TRUE((bool)ExtractedStringValue); 306 EXPECT_STREQ(StringValue, *ExtractedStringValue); 307 308 if (Version >= 5) { 309 auto ExtractedStrxValue = toString(DieDG.find(Attr_DW_FORM_strx)); 310 EXPECT_TRUE((bool)ExtractedStrxValue); 311 EXPECT_STREQ(StrxValue, *ExtractedStrxValue); 312 313 auto ExtractedStrx1Value = toString(DieDG.find(Attr_DW_FORM_strx1)); 314 EXPECT_TRUE((bool)ExtractedStrx1Value); 315 EXPECT_STREQ(Strx1Value, *ExtractedStrx1Value); 316 317 auto ExtractedStrx2Value = toString(DieDG.find(Attr_DW_FORM_strx2)); 318 EXPECT_TRUE((bool)ExtractedStrx2Value); 319 EXPECT_STREQ(Strx2Value, *ExtractedStrx2Value); 320 321 auto ExtractedStrx3Value = toString(DieDG.find(Attr_DW_FORM_strx3)); 322 EXPECT_TRUE((bool)ExtractedStrx3Value); 323 EXPECT_STREQ(Strx3Value, *ExtractedStrx3Value); 324 325 auto ExtractedStrx4Value = toString(DieDG.find(Attr_DW_FORM_strx4)); 326 EXPECT_TRUE((bool)ExtractedStrx4Value); 327 EXPECT_STREQ(Strx4Value, *ExtractedStrx4Value); 328 } 329 330 auto ExtractedStrpValue = toString(DieDG.find(Attr_DW_FORM_strp)); 331 EXPECT_TRUE((bool)ExtractedStrpValue); 332 EXPECT_STREQ(StrpValue, *ExtractedStrpValue); 333 334 //---------------------------------------------------------------------- 335 // Test reference forms 336 //---------------------------------------------------------------------- 337 EXPECT_EQ(RefAddr, toReference(DieDG.find(Attr_DW_FORM_ref_addr), 0)); 338 EXPECT_EQ(Data1, toReference(DieDG.find(Attr_DW_FORM_ref1), 0)); 339 EXPECT_EQ(Data2, toReference(DieDG.find(Attr_DW_FORM_ref2), 0)); 340 EXPECT_EQ(Data4, toReference(DieDG.find(Attr_DW_FORM_ref4), 0)); 341 EXPECT_EQ(Data8, toReference(DieDG.find(Attr_DW_FORM_ref8), 0)); 342 if (Version >= 4) { 343 EXPECT_EQ(Data8_2, toReference(DieDG.find(Attr_DW_FORM_ref_sig8), 0)); 344 } 345 EXPECT_EQ(UData[0], toReference(DieDG.find(Attr_DW_FORM_ref_udata), 0)); 346 347 //---------------------------------------------------------------------- 348 // Test flag forms 349 //---------------------------------------------------------------------- 350 EXPECT_EQ(1ULL, toUnsigned(DieDG.find(Attr_DW_FORM_flag_true), 0)); 351 EXPECT_EQ(0ULL, toUnsigned(DieDG.find(Attr_DW_FORM_flag_false), 1)); 352 if (Version >= 4) { 353 EXPECT_EQ(1ULL, toUnsigned(DieDG.find(Attr_DW_FORM_flag_present), 0)); 354 } 355 356 //---------------------------------------------------------------------- 357 // Test SLEB128 based forms 358 //---------------------------------------------------------------------- 359 EXPECT_EQ(SData, toSigned(DieDG.find(Attr_DW_FORM_sdata), 0)); 360 if (Version >= 5) { 361 EXPECT_EQ(ICSData, toSigned(DieDG.find(Attr_DW_FORM_implicit_const), 0)); 362 } 363 364 //---------------------------------------------------------------------- 365 // Test ULEB128 based forms 366 //---------------------------------------------------------------------- 367 EXPECT_EQ(UData[0], toUnsigned(DieDG.find(Attr_DW_FORM_udata), 0)); 368 369 //---------------------------------------------------------------------- 370 // Test DWARF32/DWARF64 forms 371 //---------------------------------------------------------------------- 372 EXPECT_EQ(Dwarf32Values[0], 373 toReference(DieDG.find(Attr_DW_FORM_GNU_ref_alt), 0)); 374 if (Version >= 4) { 375 EXPECT_EQ(Dwarf32Values[1], 376 toSectionOffset(DieDG.find(Attr_DW_FORM_sec_offset), 0)); 377 } 378 379 //---------------------------------------------------------------------- 380 // Add an address at the end to make sure we can decode this value 381 //---------------------------------------------------------------------- 382 EXPECT_EQ(AddrValue, toAddress(DieDG.find(Attr_Last), 0)); 383 } 384 385 TEST(DWARFDebugInfo, TestDWARF32Version2Addr4AllForms) { 386 // Test that we can decode all forms for DWARF32, version 2, with 4 byte 387 // addresses. 388 typedef uint32_t AddrType; 389 // DW_FORM_ref_addr are the same as the address type in DWARF32 version 2. 390 typedef AddrType RefAddrType; 391 TestAllForms<2, AddrType, RefAddrType>(); 392 } 393 394 TEST(DWARFDebugInfo, TestDWARF32Version2Addr8AllForms) { 395 // Test that we can decode all forms for DWARF32, version 2, with 4 byte 396 // addresses. 397 typedef uint64_t AddrType; 398 // DW_FORM_ref_addr are the same as the address type in DWARF32 version 2. 399 typedef AddrType RefAddrType; 400 TestAllForms<2, AddrType, RefAddrType>(); 401 } 402 403 TEST(DWARFDebugInfo, TestDWARF32Version3Addr4AllForms) { 404 // Test that we can decode all forms for DWARF32, version 3, with 4 byte 405 // addresses. 406 typedef uint32_t AddrType; 407 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later. 408 typedef uint32_t RefAddrType; 409 TestAllForms<3, AddrType, RefAddrType>(); 410 } 411 412 TEST(DWARFDebugInfo, TestDWARF32Version3Addr8AllForms) { 413 // Test that we can decode all forms for DWARF32, version 3, with 8 byte 414 // addresses. 415 typedef uint64_t AddrType; 416 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 417 typedef uint32_t RefAddrType; 418 TestAllForms<3, AddrType, RefAddrType>(); 419 } 420 421 TEST(DWARFDebugInfo, TestDWARF32Version4Addr4AllForms) { 422 // Test that we can decode all forms for DWARF32, version 4, with 4 byte 423 // addresses. 424 typedef uint32_t AddrType; 425 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 426 typedef uint32_t RefAddrType; 427 TestAllForms<4, AddrType, RefAddrType>(); 428 } 429 430 TEST(DWARFDebugInfo, TestDWARF32Version4Addr8AllForms) { 431 // Test that we can decode all forms for DWARF32, version 4, with 8 byte 432 // addresses. 433 typedef uint64_t AddrType; 434 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 435 typedef uint32_t RefAddrType; 436 TestAllForms<4, AddrType, RefAddrType>(); 437 } 438 439 TEST(DWARFDebugInfo, TestDWARF32Version5Addr4AllForms) { 440 // Test that we can decode all forms for DWARF32, version 5, with 4 byte 441 // addresses. 442 typedef uint32_t AddrType; 443 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 444 typedef uint32_t RefAddrType; 445 TestAllForms<5, AddrType, RefAddrType>(); 446 } 447 448 TEST(DWARFDebugInfo, TestDWARF32Version5Addr8AllForms) { 449 // Test that we can decode all forms for DWARF32, version 5, with 8 byte 450 // addresses. 451 typedef uint64_t AddrType; 452 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 453 typedef uint32_t RefAddrType; 454 TestAllForms<5, AddrType, RefAddrType>(); 455 } 456 457 template <uint16_t Version, class AddrType> void TestChildren() { 458 Triple Triple = getDefaultTargetTripleForAddrSize(sizeof(AddrType)); 459 if (!isConfigurationSupported(Triple)) 460 return; 461 462 // Test that we can decode DW_FORM_ref_addr values correctly in DWARF 2 with 463 // 4 byte addresses. DW_FORM_ref_addr values should be 4 bytes when using 464 // 8 byte addresses. 465 466 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 467 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 468 dwarfgen::Generator *DG = ExpectedDG.get().get(); 469 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 470 dwarfgen::DIE CUDie = CU.getUnitDIE(); 471 472 CUDie.addAttribute(DW_AT_name, DW_FORM_strp, "/tmp/main.c"); 473 CUDie.addAttribute(DW_AT_language, DW_FORM_data2, DW_LANG_C); 474 475 dwarfgen::DIE SubprogramDie = CUDie.addChild(DW_TAG_subprogram); 476 SubprogramDie.addAttribute(DW_AT_name, DW_FORM_strp, "main"); 477 SubprogramDie.addAttribute(DW_AT_low_pc, DW_FORM_addr, 0x1000U); 478 SubprogramDie.addAttribute(DW_AT_high_pc, DW_FORM_addr, 0x2000U); 479 480 dwarfgen::DIE IntDie = CUDie.addChild(DW_TAG_base_type); 481 IntDie.addAttribute(DW_AT_name, DW_FORM_strp, "int"); 482 IntDie.addAttribute(DW_AT_encoding, DW_FORM_data1, DW_ATE_signed); 483 IntDie.addAttribute(DW_AT_byte_size, DW_FORM_data1, 4); 484 485 dwarfgen::DIE ArgcDie = SubprogramDie.addChild(DW_TAG_formal_parameter); 486 ArgcDie.addAttribute(DW_AT_name, DW_FORM_strp, "argc"); 487 // ArgcDie.addAttribute(DW_AT_type, DW_FORM_ref4, IntDie); 488 ArgcDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, IntDie); 489 490 StringRef FileBytes = DG->generate(); 491 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 492 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 493 EXPECT_TRUE((bool)Obj); 494 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 495 496 // Verify the number of compile units is correct. 497 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 498 EXPECT_EQ(NumCUs, 1u); 499 DWARFCompileUnit *U = 500 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 501 502 // Get the compile unit DIE is valid. 503 auto DieDG = U->getUnitDIE(false); 504 EXPECT_TRUE(DieDG.isValid()); 505 506 // Verify the first child of the compile unit DIE is our subprogram. 507 auto SubprogramDieDG = DieDG.getFirstChild(); 508 EXPECT_TRUE(SubprogramDieDG.isValid()); 509 EXPECT_EQ(SubprogramDieDG.getTag(), DW_TAG_subprogram); 510 511 // Verify the first child of the subprogram is our formal parameter. 512 auto ArgcDieDG = SubprogramDieDG.getFirstChild(); 513 EXPECT_TRUE(ArgcDieDG.isValid()); 514 EXPECT_EQ(ArgcDieDG.getTag(), DW_TAG_formal_parameter); 515 516 // Verify our formal parameter has a NULL tag sibling. 517 auto NullDieDG = ArgcDieDG.getSibling(); 518 EXPECT_TRUE(NullDieDG.isValid()); 519 if (NullDieDG) { 520 EXPECT_EQ(NullDieDG.getTag(), DW_TAG_null); 521 EXPECT_TRUE(!NullDieDG.getSibling().isValid()); 522 EXPECT_TRUE(!NullDieDG.getFirstChild().isValid()); 523 } 524 525 // Verify the sibling of our subprogram is our integer base type. 526 auto IntDieDG = SubprogramDieDG.getSibling(); 527 EXPECT_TRUE(IntDieDG.isValid()); 528 EXPECT_EQ(IntDieDG.getTag(), DW_TAG_base_type); 529 530 // Verify the sibling of our subprogram is our integer base is a NULL tag. 531 NullDieDG = IntDieDG.getSibling(); 532 EXPECT_TRUE(NullDieDG.isValid()); 533 if (NullDieDG) { 534 EXPECT_EQ(NullDieDG.getTag(), DW_TAG_null); 535 EXPECT_TRUE(!NullDieDG.getSibling().isValid()); 536 EXPECT_TRUE(!NullDieDG.getFirstChild().isValid()); 537 } 538 539 // Verify the previous sibling of our subprogram is our integer base type. 540 IntDieDG = NullDieDG.getPreviousSibling(); 541 EXPECT_TRUE(IntDieDG.isValid()); 542 EXPECT_EQ(IntDieDG.getTag(), DW_TAG_base_type); 543 } 544 545 TEST(DWARFDebugInfo, TestDWARF32Version2Addr4Children) { 546 // Test that we can decode all forms for DWARF32, version 2, with 4 byte 547 // addresses. 548 typedef uint32_t AddrType; 549 TestChildren<2, AddrType>(); 550 } 551 552 TEST(DWARFDebugInfo, TestDWARF32Version2Addr8Children) { 553 // Test that we can decode all forms for DWARF32, version 2, with 8 byte 554 // addresses. 555 typedef uint64_t AddrType; 556 TestChildren<2, AddrType>(); 557 } 558 559 TEST(DWARFDebugInfo, TestDWARF32Version3Addr4Children) { 560 // Test that we can decode all forms for DWARF32, version 3, with 4 byte 561 // addresses. 562 typedef uint32_t AddrType; 563 TestChildren<3, AddrType>(); 564 } 565 566 TEST(DWARFDebugInfo, TestDWARF32Version3Addr8Children) { 567 // Test that we can decode all forms for DWARF32, version 3, with 8 byte 568 // addresses. 569 typedef uint64_t AddrType; 570 TestChildren<3, AddrType>(); 571 } 572 573 TEST(DWARFDebugInfo, TestDWARF32Version4Addr4Children) { 574 // Test that we can decode all forms for DWARF32, version 4, with 4 byte 575 // addresses. 576 typedef uint32_t AddrType; 577 TestChildren<4, AddrType>(); 578 } 579 580 TEST(DWARFDebugInfo, TestDWARF32Version4Addr8Children) { 581 // Test that we can decode all forms for DWARF32, version 4, with 8 byte 582 // addresses. 583 typedef uint64_t AddrType; 584 TestChildren<4, AddrType>(); 585 } 586 587 template <uint16_t Version, class AddrType> void TestReferences() { 588 Triple Triple = getDefaultTargetTripleForAddrSize(sizeof(AddrType)); 589 if (!isConfigurationSupported(Triple)) 590 return; 591 592 // Test that we can decode DW_FORM_refXXX values correctly in DWARF. 593 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 594 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 595 dwarfgen::Generator *DG = ExpectedDG.get().get(); 596 dwarfgen::CompileUnit &CU1 = DG->addCompileUnit(); 597 dwarfgen::CompileUnit &CU2 = DG->addCompileUnit(); 598 599 dwarfgen::DIE CU1Die = CU1.getUnitDIE(); 600 CU1Die.addAttribute(DW_AT_name, DW_FORM_strp, "/tmp/main.c"); 601 CU1Die.addAttribute(DW_AT_language, DW_FORM_data2, DW_LANG_C); 602 603 dwarfgen::DIE CU1TypeDie = CU1Die.addChild(DW_TAG_base_type); 604 CU1TypeDie.addAttribute(DW_AT_name, DW_FORM_strp, "int"); 605 CU1TypeDie.addAttribute(DW_AT_encoding, DW_FORM_data1, DW_ATE_signed); 606 CU1TypeDie.addAttribute(DW_AT_byte_size, DW_FORM_data1, 4); 607 608 dwarfgen::DIE CU1Ref1Die = CU1Die.addChild(DW_TAG_variable); 609 CU1Ref1Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU1Ref1"); 610 CU1Ref1Die.addAttribute(DW_AT_type, DW_FORM_ref1, CU1TypeDie); 611 612 dwarfgen::DIE CU1Ref2Die = CU1Die.addChild(DW_TAG_variable); 613 CU1Ref2Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU1Ref2"); 614 CU1Ref2Die.addAttribute(DW_AT_type, DW_FORM_ref2, CU1TypeDie); 615 616 dwarfgen::DIE CU1Ref4Die = CU1Die.addChild(DW_TAG_variable); 617 CU1Ref4Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU1Ref4"); 618 CU1Ref4Die.addAttribute(DW_AT_type, DW_FORM_ref4, CU1TypeDie); 619 620 dwarfgen::DIE CU1Ref8Die = CU1Die.addChild(DW_TAG_variable); 621 CU1Ref8Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU1Ref8"); 622 CU1Ref8Die.addAttribute(DW_AT_type, DW_FORM_ref8, CU1TypeDie); 623 624 dwarfgen::DIE CU1RefAddrDie = CU1Die.addChild(DW_TAG_variable); 625 CU1RefAddrDie.addAttribute(DW_AT_name, DW_FORM_strp, "CU1RefAddr"); 626 CU1RefAddrDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, CU1TypeDie); 627 628 dwarfgen::DIE CU2Die = CU2.getUnitDIE(); 629 CU2Die.addAttribute(DW_AT_name, DW_FORM_strp, "/tmp/foo.c"); 630 CU2Die.addAttribute(DW_AT_language, DW_FORM_data2, DW_LANG_C); 631 632 dwarfgen::DIE CU2TypeDie = CU2Die.addChild(DW_TAG_base_type); 633 CU2TypeDie.addAttribute(DW_AT_name, DW_FORM_strp, "float"); 634 CU2TypeDie.addAttribute(DW_AT_encoding, DW_FORM_data1, DW_ATE_float); 635 CU2TypeDie.addAttribute(DW_AT_byte_size, DW_FORM_data1, 4); 636 637 dwarfgen::DIE CU2Ref1Die = CU2Die.addChild(DW_TAG_variable); 638 CU2Ref1Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU2Ref1"); 639 CU2Ref1Die.addAttribute(DW_AT_type, DW_FORM_ref1, CU2TypeDie); 640 641 dwarfgen::DIE CU2Ref2Die = CU2Die.addChild(DW_TAG_variable); 642 CU2Ref2Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU2Ref2"); 643 CU2Ref2Die.addAttribute(DW_AT_type, DW_FORM_ref2, CU2TypeDie); 644 645 dwarfgen::DIE CU2Ref4Die = CU2Die.addChild(DW_TAG_variable); 646 CU2Ref4Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU2Ref4"); 647 CU2Ref4Die.addAttribute(DW_AT_type, DW_FORM_ref4, CU2TypeDie); 648 649 dwarfgen::DIE CU2Ref8Die = CU2Die.addChild(DW_TAG_variable); 650 CU2Ref8Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU2Ref8"); 651 CU2Ref8Die.addAttribute(DW_AT_type, DW_FORM_ref8, CU2TypeDie); 652 653 dwarfgen::DIE CU2RefAddrDie = CU2Die.addChild(DW_TAG_variable); 654 CU2RefAddrDie.addAttribute(DW_AT_name, DW_FORM_strp, "CU2RefAddr"); 655 CU2RefAddrDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, CU2TypeDie); 656 657 // Refer to a type in CU1 from CU2 658 dwarfgen::DIE CU2ToCU1RefAddrDie = CU2Die.addChild(DW_TAG_variable); 659 CU2ToCU1RefAddrDie.addAttribute(DW_AT_name, DW_FORM_strp, "CU2ToCU1RefAddr"); 660 CU2ToCU1RefAddrDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, CU1TypeDie); 661 662 // Refer to a type in CU2 from CU1 663 dwarfgen::DIE CU1ToCU2RefAddrDie = CU1Die.addChild(DW_TAG_variable); 664 CU1ToCU2RefAddrDie.addAttribute(DW_AT_name, DW_FORM_strp, "CU1ToCU2RefAddr"); 665 CU1ToCU2RefAddrDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, CU2TypeDie); 666 667 StringRef FileBytes = DG->generate(); 668 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 669 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 670 EXPECT_TRUE((bool)Obj); 671 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 672 673 // Verify the number of compile units is correct. 674 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 675 EXPECT_EQ(NumCUs, 2u); 676 DWARFCompileUnit *U1 = 677 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 678 DWARFCompileUnit *U2 = 679 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(1)); 680 681 // Get the compile unit DIE is valid. 682 auto Unit1DieDG = U1->getUnitDIE(false); 683 EXPECT_TRUE(Unit1DieDG.isValid()); 684 685 auto Unit2DieDG = U2->getUnitDIE(false); 686 EXPECT_TRUE(Unit2DieDG.isValid()); 687 688 // Verify the first child of the compile unit 1 DIE is our int base type. 689 auto CU1TypeDieDG = Unit1DieDG.getFirstChild(); 690 EXPECT_TRUE(CU1TypeDieDG.isValid()); 691 EXPECT_EQ(CU1TypeDieDG.getTag(), DW_TAG_base_type); 692 EXPECT_EQ(DW_ATE_signed, toUnsigned(CU1TypeDieDG.find(DW_AT_encoding), 0)); 693 694 // Verify the first child of the compile unit 2 DIE is our float base type. 695 auto CU2TypeDieDG = Unit2DieDG.getFirstChild(); 696 EXPECT_TRUE(CU2TypeDieDG.isValid()); 697 EXPECT_EQ(CU2TypeDieDG.getTag(), DW_TAG_base_type); 698 EXPECT_EQ(DW_ATE_float, toUnsigned(CU2TypeDieDG.find(DW_AT_encoding), 0)); 699 700 // Verify the sibling of the base type DIE is our Ref1 DIE and that its 701 // DW_AT_type points to our base type DIE. 702 auto CU1Ref1DieDG = CU1TypeDieDG.getSibling(); 703 EXPECT_TRUE(CU1Ref1DieDG.isValid()); 704 EXPECT_EQ(CU1Ref1DieDG.getTag(), DW_TAG_variable); 705 EXPECT_EQ(CU1TypeDieDG.getOffset(), 706 toReference(CU1Ref1DieDG.find(DW_AT_type), -1ULL)); 707 // Verify the sibling is our Ref2 DIE and that its DW_AT_type points to our 708 // base type DIE in CU1. 709 auto CU1Ref2DieDG = CU1Ref1DieDG.getSibling(); 710 EXPECT_TRUE(CU1Ref2DieDG.isValid()); 711 EXPECT_EQ(CU1Ref2DieDG.getTag(), DW_TAG_variable); 712 EXPECT_EQ(CU1TypeDieDG.getOffset(), 713 toReference(CU1Ref2DieDG.find(DW_AT_type), -1ULL)); 714 715 // Verify the sibling is our Ref4 DIE and that its DW_AT_type points to our 716 // base type DIE in CU1. 717 auto CU1Ref4DieDG = CU1Ref2DieDG.getSibling(); 718 EXPECT_TRUE(CU1Ref4DieDG.isValid()); 719 EXPECT_EQ(CU1Ref4DieDG.getTag(), DW_TAG_variable); 720 EXPECT_EQ(CU1TypeDieDG.getOffset(), 721 toReference(CU1Ref4DieDG.find(DW_AT_type), -1ULL)); 722 723 // Verify the sibling is our Ref8 DIE and that its DW_AT_type points to our 724 // base type DIE in CU1. 725 auto CU1Ref8DieDG = CU1Ref4DieDG.getSibling(); 726 EXPECT_TRUE(CU1Ref8DieDG.isValid()); 727 EXPECT_EQ(CU1Ref8DieDG.getTag(), DW_TAG_variable); 728 EXPECT_EQ(CU1TypeDieDG.getOffset(), 729 toReference(CU1Ref8DieDG.find(DW_AT_type), -1ULL)); 730 731 // Verify the sibling is our RefAddr DIE and that its DW_AT_type points to our 732 // base type DIE in CU1. 733 auto CU1RefAddrDieDG = CU1Ref8DieDG.getSibling(); 734 EXPECT_TRUE(CU1RefAddrDieDG.isValid()); 735 EXPECT_EQ(CU1RefAddrDieDG.getTag(), DW_TAG_variable); 736 EXPECT_EQ(CU1TypeDieDG.getOffset(), 737 toReference(CU1RefAddrDieDG.find(DW_AT_type), -1ULL)); 738 739 // Verify the sibling of the Ref4 DIE is our RefAddr DIE and that its 740 // DW_AT_type points to our base type DIE. 741 auto CU1ToCU2RefAddrDieDG = CU1RefAddrDieDG.getSibling(); 742 EXPECT_TRUE(CU1ToCU2RefAddrDieDG.isValid()); 743 EXPECT_EQ(CU1ToCU2RefAddrDieDG.getTag(), DW_TAG_variable); 744 EXPECT_EQ(CU2TypeDieDG.getOffset(), 745 toReference(CU1ToCU2RefAddrDieDG.find(DW_AT_type), -1ULL)); 746 747 // Verify the sibling of the base type DIE is our Ref1 DIE and that its 748 // DW_AT_type points to our base type DIE. 749 auto CU2Ref1DieDG = CU2TypeDieDG.getSibling(); 750 EXPECT_TRUE(CU2Ref1DieDG.isValid()); 751 EXPECT_EQ(CU2Ref1DieDG.getTag(), DW_TAG_variable); 752 EXPECT_EQ(CU2TypeDieDG.getOffset(), 753 toReference(CU2Ref1DieDG.find(DW_AT_type), -1ULL)); 754 // Verify the sibling is our Ref2 DIE and that its DW_AT_type points to our 755 // base type DIE in CU2. 756 auto CU2Ref2DieDG = CU2Ref1DieDG.getSibling(); 757 EXPECT_TRUE(CU2Ref2DieDG.isValid()); 758 EXPECT_EQ(CU2Ref2DieDG.getTag(), DW_TAG_variable); 759 EXPECT_EQ(CU2TypeDieDG.getOffset(), 760 toReference(CU2Ref2DieDG.find(DW_AT_type), -1ULL)); 761 762 // Verify the sibling is our Ref4 DIE and that its DW_AT_type points to our 763 // base type DIE in CU2. 764 auto CU2Ref4DieDG = CU2Ref2DieDG.getSibling(); 765 EXPECT_TRUE(CU2Ref4DieDG.isValid()); 766 EXPECT_EQ(CU2Ref4DieDG.getTag(), DW_TAG_variable); 767 EXPECT_EQ(CU2TypeDieDG.getOffset(), 768 toReference(CU2Ref4DieDG.find(DW_AT_type), -1ULL)); 769 770 // Verify the sibling is our Ref8 DIE and that its DW_AT_type points to our 771 // base type DIE in CU2. 772 auto CU2Ref8DieDG = CU2Ref4DieDG.getSibling(); 773 EXPECT_TRUE(CU2Ref8DieDG.isValid()); 774 EXPECT_EQ(CU2Ref8DieDG.getTag(), DW_TAG_variable); 775 EXPECT_EQ(CU2TypeDieDG.getOffset(), 776 toReference(CU2Ref8DieDG.find(DW_AT_type), -1ULL)); 777 778 // Verify the sibling is our RefAddr DIE and that its DW_AT_type points to our 779 // base type DIE in CU2. 780 auto CU2RefAddrDieDG = CU2Ref8DieDG.getSibling(); 781 EXPECT_TRUE(CU2RefAddrDieDG.isValid()); 782 EXPECT_EQ(CU2RefAddrDieDG.getTag(), DW_TAG_variable); 783 EXPECT_EQ(CU2TypeDieDG.getOffset(), 784 toReference(CU2RefAddrDieDG.find(DW_AT_type), -1ULL)); 785 786 // Verify the sibling of the Ref4 DIE is our RefAddr DIE and that its 787 // DW_AT_type points to our base type DIE. 788 auto CU2ToCU1RefAddrDieDG = CU2RefAddrDieDG.getSibling(); 789 EXPECT_TRUE(CU2ToCU1RefAddrDieDG.isValid()); 790 EXPECT_EQ(CU2ToCU1RefAddrDieDG.getTag(), DW_TAG_variable); 791 EXPECT_EQ(CU1TypeDieDG.getOffset(), 792 toReference(CU2ToCU1RefAddrDieDG.find(DW_AT_type), -1ULL)); 793 } 794 795 TEST(DWARFDebugInfo, TestDWARF32Version2Addr4References) { 796 // Test that we can decode all forms for DWARF32, version 2, with 4 byte 797 // addresses. 798 typedef uint32_t AddrType; 799 TestReferences<2, AddrType>(); 800 } 801 802 TEST(DWARFDebugInfo, TestDWARF32Version2Addr8References) { 803 // Test that we can decode all forms for DWARF32, version 2, with 8 byte 804 // addresses. 805 typedef uint64_t AddrType; 806 TestReferences<2, AddrType>(); 807 } 808 809 TEST(DWARFDebugInfo, TestDWARF32Version3Addr4References) { 810 // Test that we can decode all forms for DWARF32, version 3, with 4 byte 811 // addresses. 812 typedef uint32_t AddrType; 813 TestReferences<3, AddrType>(); 814 } 815 816 TEST(DWARFDebugInfo, TestDWARF32Version3Addr8References) { 817 // Test that we can decode all forms for DWARF32, version 3, with 8 byte 818 // addresses. 819 typedef uint64_t AddrType; 820 TestReferences<3, AddrType>(); 821 } 822 823 TEST(DWARFDebugInfo, TestDWARF32Version4Addr4References) { 824 // Test that we can decode all forms for DWARF32, version 4, with 4 byte 825 // addresses. 826 typedef uint32_t AddrType; 827 TestReferences<4, AddrType>(); 828 } 829 830 TEST(DWARFDebugInfo, TestDWARF32Version4Addr8References) { 831 // Test that we can decode all forms for DWARF32, version 4, with 8 byte 832 // addresses. 833 typedef uint64_t AddrType; 834 TestReferences<4, AddrType>(); 835 } 836 837 template <uint16_t Version, class AddrType> void TestAddresses() { 838 Triple Triple = getDefaultTargetTripleForAddrSize(sizeof(AddrType)); 839 if (!isConfigurationSupported(Triple)) 840 return; 841 842 // Test the DWARF APIs related to accessing the DW_AT_low_pc and 843 // DW_AT_high_pc. 844 const bool SupportsHighPCAsOffset = Version >= 4; 845 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 846 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 847 dwarfgen::Generator *DG = ExpectedDG.get().get(); 848 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 849 dwarfgen::DIE CUDie = CU.getUnitDIE(); 850 851 CUDie.addAttribute(DW_AT_name, DW_FORM_strp, "/tmp/main.c"); 852 CUDie.addAttribute(DW_AT_language, DW_FORM_data2, DW_LANG_C); 853 854 // Create a subprogram DIE with no low or high PC. 855 dwarfgen::DIE SubprogramNoPC = CUDie.addChild(DW_TAG_subprogram); 856 SubprogramNoPC.addAttribute(DW_AT_name, DW_FORM_strp, "no_pc"); 857 858 // Create a subprogram DIE with a low PC only. 859 dwarfgen::DIE SubprogramLowPC = CUDie.addChild(DW_TAG_subprogram); 860 SubprogramLowPC.addAttribute(DW_AT_name, DW_FORM_strp, "low_pc"); 861 const uint64_t ActualLowPC = 0x1000; 862 const uint64_t ActualHighPC = 0x2000; 863 const uint64_t ActualHighPCOffset = ActualHighPC - ActualLowPC; 864 SubprogramLowPC.addAttribute(DW_AT_low_pc, DW_FORM_addr, ActualLowPC); 865 866 // Create a subprogram DIE with a low and high PC. 867 dwarfgen::DIE SubprogramLowHighPC = CUDie.addChild(DW_TAG_subprogram); 868 SubprogramLowHighPC.addAttribute(DW_AT_name, DW_FORM_strp, "low_high_pc"); 869 SubprogramLowHighPC.addAttribute(DW_AT_low_pc, DW_FORM_addr, ActualLowPC); 870 // Encode the high PC as an offset from the low PC if supported. 871 if (SupportsHighPCAsOffset) 872 SubprogramLowHighPC.addAttribute(DW_AT_high_pc, DW_FORM_data4, 873 ActualHighPCOffset); 874 else 875 SubprogramLowHighPC.addAttribute(DW_AT_high_pc, DW_FORM_addr, ActualHighPC); 876 877 StringRef FileBytes = DG->generate(); 878 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 879 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 880 EXPECT_TRUE((bool)Obj); 881 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 882 883 // Verify the number of compile units is correct. 884 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 885 EXPECT_EQ(NumCUs, 1u); 886 DWARFCompileUnit *U = 887 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 888 889 // Get the compile unit DIE is valid. 890 auto DieDG = U->getUnitDIE(false); 891 EXPECT_TRUE(DieDG.isValid()); 892 893 uint64_t LowPC, HighPC, SectionIndex; 894 Optional<uint64_t> OptU64; 895 // Verify the that our subprogram with no PC value fails appropriately when 896 // asked for any PC values. 897 auto SubprogramDieNoPC = DieDG.getFirstChild(); 898 EXPECT_TRUE(SubprogramDieNoPC.isValid()); 899 EXPECT_EQ(SubprogramDieNoPC.getTag(), DW_TAG_subprogram); 900 OptU64 = toAddress(SubprogramDieNoPC.find(DW_AT_low_pc)); 901 EXPECT_FALSE((bool)OptU64); 902 OptU64 = toAddress(SubprogramDieNoPC.find(DW_AT_high_pc)); 903 EXPECT_FALSE((bool)OptU64); 904 EXPECT_FALSE(SubprogramDieNoPC.getLowAndHighPC(LowPC, HighPC, SectionIndex)); 905 OptU64 = toAddress(SubprogramDieNoPC.find(DW_AT_high_pc)); 906 EXPECT_FALSE((bool)OptU64); 907 OptU64 = toUnsigned(SubprogramDieNoPC.find(DW_AT_high_pc)); 908 EXPECT_FALSE((bool)OptU64); 909 OptU64 = SubprogramDieNoPC.getHighPC(ActualLowPC); 910 EXPECT_FALSE((bool)OptU64); 911 EXPECT_FALSE(SubprogramDieNoPC.getLowAndHighPC(LowPC, HighPC, SectionIndex)); 912 913 // Verify the that our subprogram with only a low PC value succeeds when 914 // we ask for the Low PC, but fails appropriately when asked for the high PC 915 // or both low and high PC values. 916 auto SubprogramDieLowPC = SubprogramDieNoPC.getSibling(); 917 EXPECT_TRUE(SubprogramDieLowPC.isValid()); 918 EXPECT_EQ(SubprogramDieLowPC.getTag(), DW_TAG_subprogram); 919 OptU64 = toAddress(SubprogramDieLowPC.find(DW_AT_low_pc)); 920 EXPECT_TRUE((bool)OptU64); 921 EXPECT_EQ(OptU64.getValue(), ActualLowPC); 922 OptU64 = toAddress(SubprogramDieLowPC.find(DW_AT_high_pc)); 923 EXPECT_FALSE((bool)OptU64); 924 OptU64 = toUnsigned(SubprogramDieLowPC.find(DW_AT_high_pc)); 925 EXPECT_FALSE((bool)OptU64); 926 OptU64 = SubprogramDieLowPC.getHighPC(ActualLowPC); 927 EXPECT_FALSE((bool)OptU64); 928 EXPECT_FALSE(SubprogramDieLowPC.getLowAndHighPC(LowPC, HighPC, SectionIndex)); 929 930 // Verify the that our subprogram with only a low PC value succeeds when 931 // we ask for the Low PC, but fails appropriately when asked for the high PC 932 // or both low and high PC values. 933 auto SubprogramDieLowHighPC = SubprogramDieLowPC.getSibling(); 934 EXPECT_TRUE(SubprogramDieLowHighPC.isValid()); 935 EXPECT_EQ(SubprogramDieLowHighPC.getTag(), DW_TAG_subprogram); 936 OptU64 = toAddress(SubprogramDieLowHighPC.find(DW_AT_low_pc)); 937 EXPECT_TRUE((bool)OptU64); 938 EXPECT_EQ(OptU64.getValue(), ActualLowPC); 939 // Get the high PC as an address. This should succeed if the high PC was 940 // encoded as an address and fail if the high PC was encoded as an offset. 941 OptU64 = toAddress(SubprogramDieLowHighPC.find(DW_AT_high_pc)); 942 if (SupportsHighPCAsOffset) { 943 EXPECT_FALSE((bool)OptU64); 944 } else { 945 EXPECT_TRUE((bool)OptU64); 946 EXPECT_EQ(OptU64.getValue(), ActualHighPC); 947 } 948 // Get the high PC as an unsigned constant. This should succeed if the high PC 949 // was encoded as an offset and fail if the high PC was encoded as an address. 950 OptU64 = toUnsigned(SubprogramDieLowHighPC.find(DW_AT_high_pc)); 951 if (SupportsHighPCAsOffset) { 952 EXPECT_TRUE((bool)OptU64); 953 EXPECT_EQ(OptU64.getValue(), ActualHighPCOffset); 954 } else { 955 EXPECT_FALSE((bool)OptU64); 956 } 957 958 OptU64 = SubprogramDieLowHighPC.getHighPC(ActualLowPC); 959 EXPECT_TRUE((bool)OptU64); 960 EXPECT_EQ(OptU64.getValue(), ActualHighPC); 961 962 EXPECT_TRUE(SubprogramDieLowHighPC.getLowAndHighPC(LowPC, HighPC, SectionIndex)); 963 EXPECT_EQ(LowPC, ActualLowPC); 964 EXPECT_EQ(HighPC, ActualHighPC); 965 } 966 967 TEST(DWARFDebugInfo, TestDWARF32Version2Addr4Addresses) { 968 // Test that we can decode address values in DWARF32, version 2, with 4 byte 969 // addresses. 970 typedef uint32_t AddrType; 971 TestAddresses<2, AddrType>(); 972 } 973 974 TEST(DWARFDebugInfo, TestDWARF32Version2Addr8Addresses) { 975 // Test that we can decode address values in DWARF32, version 2, with 8 byte 976 // addresses. 977 typedef uint64_t AddrType; 978 TestAddresses<2, AddrType>(); 979 } 980 981 TEST(DWARFDebugInfo, TestDWARF32Version3Addr4Addresses) { 982 // Test that we can decode address values in DWARF32, version 3, with 4 byte 983 // addresses. 984 typedef uint32_t AddrType; 985 TestAddresses<3, AddrType>(); 986 } 987 988 TEST(DWARFDebugInfo, TestDWARF32Version3Addr8Addresses) { 989 // Test that we can decode address values in DWARF32, version 3, with 8 byte 990 // addresses. 991 typedef uint64_t AddrType; 992 TestAddresses<3, AddrType>(); 993 } 994 995 TEST(DWARFDebugInfo, TestDWARF32Version4Addr4Addresses) { 996 // Test that we can decode address values in DWARF32, version 4, with 4 byte 997 // addresses. 998 typedef uint32_t AddrType; 999 TestAddresses<4, AddrType>(); 1000 } 1001 1002 TEST(DWARFDebugInfo, TestDWARF32Version4Addr8Addresses) { 1003 // Test that we can decode address values in DWARF32, version 4, with 8 byte 1004 // addresses. 1005 typedef uint64_t AddrType; 1006 TestAddresses<4, AddrType>(); 1007 } 1008 1009 TEST(DWARFDebugInfo, TestStringOffsets) { 1010 Triple Triple = getNormalizedDefaultTargetTriple(); 1011 if (!isConfigurationSupported(Triple)) 1012 return; 1013 1014 const char *String1 = "Hello"; 1015 const char *String2 = "World"; 1016 1017 auto ExpectedDG = dwarfgen::Generator::create(Triple, 5); 1018 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1019 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1020 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1021 dwarfgen::DIE CUDie = CU.getUnitDIE(); 1022 1023 CUDie.addStrOffsetsBaseAttribute(); 1024 1025 uint16_t Attr = DW_AT_lo_user; 1026 1027 // Create our strings. First we create a non-indexed reference to String1, 1028 // followed by an indexed String2. Finally, we add an indexed reference to 1029 // String1. 1030 const auto Attr1 = static_cast<dwarf::Attribute>(Attr++); 1031 CUDie.addAttribute(Attr1, DW_FORM_strp, String1); 1032 1033 const auto Attr2 = static_cast<dwarf::Attribute>(Attr++); 1034 CUDie.addAttribute(Attr2, DW_FORM_strx, String2); 1035 1036 const auto Attr3 = static_cast<dwarf::Attribute>(Attr++); 1037 CUDie.addAttribute(Attr3, DW_FORM_strx, String1); 1038 1039 // Generate the DWARF 1040 StringRef FileBytes = DG->generate(); 1041 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 1042 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1043 ASSERT_TRUE((bool)Obj); 1044 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1045 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1046 ASSERT_EQ(NumCUs, 1u); 1047 DWARFUnit *U = DwarfContext->getUnitAtIndex(0); 1048 auto DieDG = U->getUnitDIE(false); 1049 ASSERT_TRUE(DieDG.isValid()); 1050 1051 // Now make sure the string offsets came out properly. Attr2 should have index 1052 // 0 (because it was the first indexed string) even though the string itself 1053 // was added eariler. 1054 auto Extracted1 = toString(DieDG.find(Attr1)); 1055 ASSERT_TRUE((bool)Extracted1); 1056 EXPECT_STREQ(String1, *Extracted1); 1057 1058 Optional<DWARFFormValue> Form2 = DieDG.find(Attr2); 1059 ASSERT_TRUE((bool)Form2); 1060 EXPECT_EQ(0u, Form2->getRawUValue()); 1061 auto Extracted2 = toString(Form2); 1062 ASSERT_TRUE((bool)Extracted2); 1063 EXPECT_STREQ(String2, *Extracted2); 1064 1065 Optional<DWARFFormValue> Form3 = DieDG.find(Attr3); 1066 ASSERT_TRUE((bool)Form3); 1067 EXPECT_EQ(1u, Form3->getRawUValue()); 1068 auto Extracted3 = toString(Form3); 1069 ASSERT_TRUE((bool)Extracted3); 1070 EXPECT_STREQ(String1, *Extracted3); 1071 } 1072 1073 TEST(DWARFDebugInfo, TestEmptyStringOffsets) { 1074 Triple Triple = getNormalizedDefaultTargetTriple(); 1075 if (!isConfigurationSupported(Triple)) 1076 return; 1077 1078 const char *String1 = "Hello"; 1079 1080 auto ExpectedDG = dwarfgen::Generator::create(Triple, 5); 1081 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1082 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1083 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1084 dwarfgen::DIE CUDie = CU.getUnitDIE(); 1085 1086 uint16_t Attr = DW_AT_lo_user; 1087 1088 // We shall insert only one string. It will be referenced directly. 1089 const auto Attr1 = static_cast<dwarf::Attribute>(Attr++); 1090 CUDie.addAttribute(Attr1, DW_FORM_strp, String1); 1091 1092 // Generate the DWARF 1093 StringRef FileBytes = DG->generate(); 1094 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 1095 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1096 ASSERT_TRUE((bool)Obj); 1097 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1098 EXPECT_TRUE( 1099 DwarfContext->getDWARFObj().getStrOffsetsSection().Data.empty()); 1100 } 1101 1102 TEST(DWARFDebugInfo, TestRelations) { 1103 Triple Triple = getNormalizedDefaultTargetTriple(); 1104 if (!isConfigurationSupported(Triple)) 1105 return; 1106 1107 // Test the DWARF APIs related to accessing the DW_AT_low_pc and 1108 // DW_AT_high_pc. 1109 uint16_t Version = 4; 1110 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1111 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1112 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1113 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1114 1115 enum class Tag: uint16_t { 1116 A = dwarf::DW_TAG_lo_user, 1117 B, 1118 C, 1119 C1, 1120 C2, 1121 D, 1122 D1 1123 }; 1124 1125 // Scope to allow us to re-use the same DIE names 1126 { 1127 // Create DWARF tree that looks like: 1128 // 1129 // CU 1130 // A 1131 // B 1132 // C 1133 // C1 1134 // C2 1135 // D 1136 // D1 1137 dwarfgen::DIE CUDie = CU.getUnitDIE(); 1138 dwarfgen::DIE A = CUDie.addChild((dwarf::Tag)Tag::A); 1139 A.addChild((dwarf::Tag)Tag::B); 1140 dwarfgen::DIE C = A.addChild((dwarf::Tag)Tag::C); 1141 dwarfgen::DIE D = A.addChild((dwarf::Tag)Tag::D); 1142 C.addChild((dwarf::Tag)Tag::C1); 1143 C.addChild((dwarf::Tag)Tag::C2); 1144 D.addChild((dwarf::Tag)Tag::D1); 1145 } 1146 1147 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1148 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1149 EXPECT_TRUE((bool)Obj); 1150 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1151 1152 // Verify the number of compile units is correct. 1153 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1154 EXPECT_EQ(NumCUs, 1u); 1155 DWARFCompileUnit *U = 1156 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1157 1158 // Get the compile unit DIE is valid. 1159 auto CUDie = U->getUnitDIE(false); 1160 EXPECT_TRUE(CUDie.isValid()); 1161 1162 // The compile unit doesn't have a parent or a sibling. 1163 auto ParentDie = CUDie.getParent(); 1164 EXPECT_FALSE(ParentDie.isValid()); 1165 auto SiblingDie = CUDie.getSibling(); 1166 EXPECT_FALSE(SiblingDie.isValid()); 1167 1168 // Get the children of the compile unit 1169 auto A = CUDie.getFirstChild(); 1170 auto B = A.getFirstChild(); 1171 auto C = B.getSibling(); 1172 auto D = C.getSibling(); 1173 auto Null = D.getSibling(); 1174 1175 // Verify NULL Die is NULL and has no children or siblings 1176 EXPECT_TRUE(Null.isNULL()); 1177 EXPECT_FALSE(Null.getSibling().isValid()); 1178 EXPECT_FALSE(Null.getFirstChild().isValid()); 1179 1180 // Verify all children of the compile unit DIE are correct. 1181 EXPECT_EQ(A.getTag(), (dwarf::Tag)Tag::A); 1182 EXPECT_EQ(B.getTag(), (dwarf::Tag)Tag::B); 1183 EXPECT_EQ(C.getTag(), (dwarf::Tag)Tag::C); 1184 EXPECT_EQ(D.getTag(), (dwarf::Tag)Tag::D); 1185 1186 // Verify who has children 1187 EXPECT_TRUE(A.hasChildren()); 1188 EXPECT_FALSE(B.hasChildren()); 1189 EXPECT_TRUE(C.hasChildren()); 1190 EXPECT_TRUE(D.hasChildren()); 1191 1192 // Make sure the parent of all the children of the compile unit are the 1193 // compile unit. 1194 EXPECT_EQ(A.getParent(), CUDie); 1195 1196 // Make sure the parent of all the children of A are the A. 1197 // B is the first child in A, so we need to verify we can get the previous 1198 // DIE as the parent. 1199 EXPECT_EQ(B.getParent(), A); 1200 // C is the second child in A, so we need to make sure we can backup across 1201 // other DIE (B) at the same level to get the correct parent. 1202 EXPECT_EQ(C.getParent(), A); 1203 // D is the third child of A. We need to verify we can backup across other DIE 1204 // (B and C) including DIE that have children (D) to get the correct parent. 1205 EXPECT_EQ(D.getParent(), A); 1206 1207 // Verify that a DIE with no children returns an invalid DWARFDie. 1208 EXPECT_FALSE(B.getFirstChild().isValid()); 1209 1210 // Verify the children of the B DIE 1211 auto C1 = C.getFirstChild(); 1212 auto C2 = C1.getSibling(); 1213 EXPECT_TRUE(C2.getSibling().isNULL()); 1214 1215 // Verify all children of the B DIE correctly valid or invalid. 1216 EXPECT_EQ(C1.getTag(), (dwarf::Tag)Tag::C1); 1217 EXPECT_EQ(C2.getTag(), (dwarf::Tag)Tag::C2); 1218 1219 // Make sure the parent of all the children of the B are the B. 1220 EXPECT_EQ(C1.getParent(), C); 1221 EXPECT_EQ(C2.getParent(), C); 1222 1223 // Make sure iterators work as expected. 1224 EXPECT_THAT(std::vector<DWARFDie>(A.begin(), A.end()), 1225 testing::ElementsAre(B, C, D)); 1226 EXPECT_THAT(std::vector<DWARFDie>(A.rbegin(), A.rend()), 1227 testing::ElementsAre(D, C, B)); 1228 1229 // Make sure conversion from reverse iterator works as expected. 1230 EXPECT_EQ(A.rbegin().base(), A.end()); 1231 EXPECT_EQ(A.rend().base(), A.begin()); 1232 1233 // Make sure iterator is bidirectional. 1234 { 1235 auto Begin = A.begin(); 1236 auto End = A.end(); 1237 auto It = A.begin(); 1238 1239 EXPECT_EQ(It, Begin); 1240 EXPECT_EQ(*It, B); 1241 ++It; 1242 EXPECT_EQ(*It, C); 1243 ++It; 1244 EXPECT_EQ(*It, D); 1245 ++It; 1246 EXPECT_EQ(It, End); 1247 --It; 1248 EXPECT_EQ(*It, D); 1249 --It; 1250 EXPECT_EQ(*It, C); 1251 --It; 1252 EXPECT_EQ(*It, B); 1253 EXPECT_EQ(It, Begin); 1254 } 1255 1256 // Make sure reverse iterator is bidirectional. 1257 { 1258 auto Begin = A.rbegin(); 1259 auto End = A.rend(); 1260 auto It = A.rbegin(); 1261 1262 EXPECT_EQ(It, Begin); 1263 EXPECT_EQ(*It, D); 1264 ++It; 1265 EXPECT_EQ(*It, C); 1266 ++It; 1267 EXPECT_EQ(*It, B); 1268 ++It; 1269 EXPECT_EQ(It, End); 1270 --It; 1271 EXPECT_EQ(*It, B); 1272 --It; 1273 EXPECT_EQ(*It, C); 1274 --It; 1275 EXPECT_EQ(*It, D); 1276 EXPECT_EQ(It, Begin); 1277 } 1278 } 1279 1280 TEST(DWARFDebugInfo, TestDWARFDie) { 1281 // Make sure a default constructed DWARFDie doesn't have any parent, sibling 1282 // or child; 1283 DWARFDie DefaultDie; 1284 EXPECT_FALSE(DefaultDie.getParent().isValid()); 1285 EXPECT_FALSE(DefaultDie.getFirstChild().isValid()); 1286 EXPECT_FALSE(DefaultDie.getSibling().isValid()); 1287 } 1288 1289 TEST(DWARFDebugInfo, TestChildIterators) { 1290 Triple Triple = getNormalizedDefaultTargetTriple(); 1291 if (!isConfigurationSupported(Triple)) 1292 return; 1293 1294 // Test the DWARF APIs related to iterating across the children of a DIE using 1295 // the DWARFDie::iterator class. 1296 uint16_t Version = 4; 1297 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1298 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1299 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1300 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1301 1302 enum class Tag: uint16_t { 1303 A = dwarf::DW_TAG_lo_user, 1304 B, 1305 }; 1306 1307 // Scope to allow us to re-use the same DIE names 1308 { 1309 // Create DWARF tree that looks like: 1310 // 1311 // CU 1312 // A 1313 // B 1314 auto CUDie = CU.getUnitDIE(); 1315 CUDie.addChild((dwarf::Tag)Tag::A); 1316 CUDie.addChild((dwarf::Tag)Tag::B); 1317 } 1318 1319 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1320 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1321 EXPECT_TRUE((bool)Obj); 1322 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1323 1324 // Verify the number of compile units is correct. 1325 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1326 EXPECT_EQ(NumCUs, 1u); 1327 DWARFCompileUnit *U = 1328 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1329 1330 // Get the compile unit DIE is valid. 1331 auto CUDie = U->getUnitDIE(false); 1332 EXPECT_TRUE(CUDie.isValid()); 1333 uint32_t Index; 1334 DWARFDie A; 1335 DWARFDie B; 1336 1337 // Verify the compile unit DIE's children. 1338 Index = 0; 1339 for (auto Die : CUDie.children()) { 1340 switch (Index++) { 1341 case 0: A = Die; break; 1342 case 1: B = Die; break; 1343 } 1344 } 1345 1346 EXPECT_EQ(A.getTag(), (dwarf::Tag)Tag::A); 1347 EXPECT_EQ(B.getTag(), (dwarf::Tag)Tag::B); 1348 1349 // Verify that A has no children by verifying that the begin and end contain 1350 // invalid DIEs and also that the iterators are equal. 1351 EXPECT_EQ(A.begin(), A.end()); 1352 } 1353 1354 TEST(DWARFDebugInfo, TestChildIteratorsOnInvalidDie) { 1355 // Verify that an invalid DIE has no children. 1356 DWARFDie Invalid; 1357 auto begin = Invalid.begin(); 1358 auto end = Invalid.end(); 1359 EXPECT_FALSE(begin->isValid()); 1360 EXPECT_FALSE(end->isValid()); 1361 EXPECT_EQ(begin, end); 1362 } 1363 1364 TEST(DWARFDebugInfo, TestEmptyChildren) { 1365 const char *yamldata = "debug_abbrev:\n" 1366 " - Table:\n" 1367 " - Code: 0x00000001\n" 1368 " Tag: DW_TAG_compile_unit\n" 1369 " Children: DW_CHILDREN_yes\n" 1370 " Attributes:\n" 1371 "debug_info:\n" 1372 " - Version: 4\n" 1373 " AbbrOffset: 0\n" 1374 " AddrSize: 8\n" 1375 " Entries:\n" 1376 " - AbbrCode: 0x00000001\n" 1377 " Values:\n" 1378 " - AbbrCode: 0x00000000\n" 1379 " Values:\n"; 1380 1381 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 1382 ASSERT_TRUE((bool)ErrOrSections); 1383 std::unique_ptr<DWARFContext> DwarfContext = 1384 DWARFContext::create(*ErrOrSections, 8); 1385 1386 // Verify the number of compile units is correct. 1387 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1388 EXPECT_EQ(NumCUs, 1u); 1389 DWARFCompileUnit *U = 1390 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1391 1392 // Get the compile unit DIE is valid. 1393 auto CUDie = U->getUnitDIE(false); 1394 EXPECT_TRUE(CUDie.isValid()); 1395 1396 // Verify that the CU Die that says it has children, but doesn't, actually 1397 // has begin and end iterators that are equal. We want to make sure we don't 1398 // see the Null DIEs during iteration. 1399 EXPECT_EQ(CUDie.begin(), CUDie.end()); 1400 } 1401 1402 TEST(DWARFDebugInfo, TestAttributeIterators) { 1403 Triple Triple = getNormalizedDefaultTargetTriple(); 1404 if (!isConfigurationSupported(Triple)) 1405 return; 1406 1407 // Test the DWARF APIs related to iterating across all attribute values in a 1408 // a DWARFDie. 1409 uint16_t Version = 4; 1410 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1411 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1412 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1413 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1414 const uint64_t CULowPC = 0x1000; 1415 StringRef CUPath("/tmp/main.c"); 1416 1417 // Scope to allow us to re-use the same DIE names 1418 { 1419 auto CUDie = CU.getUnitDIE(); 1420 // Encode an attribute value before an attribute with no data. 1421 CUDie.addAttribute(DW_AT_name, DW_FORM_strp, CUPath.data()); 1422 // Encode an attribute value with no data in .debug_info/types to ensure 1423 // the iteration works correctly. 1424 CUDie.addAttribute(DW_AT_declaration, DW_FORM_flag_present); 1425 // Encode an attribute value after an attribute with no data. 1426 CUDie.addAttribute(DW_AT_low_pc, DW_FORM_addr, CULowPC); 1427 } 1428 1429 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1430 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1431 EXPECT_TRUE((bool)Obj); 1432 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1433 1434 // Verify the number of compile units is correct. 1435 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1436 EXPECT_EQ(NumCUs, 1u); 1437 DWARFCompileUnit *U = 1438 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1439 1440 // Get the compile unit DIE is valid. 1441 auto CUDie = U->getUnitDIE(false); 1442 EXPECT_TRUE(CUDie.isValid()); 1443 1444 auto R = CUDie.attributes(); 1445 auto I = R.begin(); 1446 auto E = R.end(); 1447 1448 ASSERT_NE(E, I); 1449 EXPECT_EQ(I->Attr, DW_AT_name); 1450 auto ActualCUPath = I->Value.getAsCString(); 1451 EXPECT_EQ(CUPath, *ActualCUPath); 1452 1453 ASSERT_NE(E, ++I); 1454 EXPECT_EQ(I->Attr, DW_AT_declaration); 1455 EXPECT_EQ(1ull, *I->Value.getAsUnsignedConstant()); 1456 1457 ASSERT_NE(E, ++I); 1458 EXPECT_EQ(I->Attr, DW_AT_low_pc); 1459 EXPECT_EQ(CULowPC, *I->Value.getAsAddress()); 1460 1461 EXPECT_EQ(E, ++I); 1462 } 1463 1464 TEST(DWARFDebugInfo, TestFindRecurse) { 1465 Triple Triple = getNormalizedDefaultTargetTriple(); 1466 if (!isConfigurationSupported(Triple)) 1467 return; 1468 1469 uint16_t Version = 4; 1470 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1471 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1472 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1473 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1474 1475 StringRef SpecDieName = "spec"; 1476 StringRef SpecLinkageName = "spec_linkage"; 1477 StringRef AbsDieName = "abs"; 1478 // Scope to allow us to re-use the same DIE names 1479 { 1480 auto CUDie = CU.getUnitDIE(); 1481 auto FuncSpecDie = CUDie.addChild(DW_TAG_subprogram); 1482 auto FuncAbsDie = CUDie.addChild(DW_TAG_subprogram); 1483 // Put the linkage name in a second abstract origin DIE to ensure we 1484 // recurse through more than just one DIE when looking for attributes. 1485 auto FuncAbsDie2 = CUDie.addChild(DW_TAG_subprogram); 1486 auto FuncDie = CUDie.addChild(DW_TAG_subprogram); 1487 auto VarAbsDie = CUDie.addChild(DW_TAG_variable); 1488 auto VarDie = CUDie.addChild(DW_TAG_variable); 1489 FuncSpecDie.addAttribute(DW_AT_name, DW_FORM_strp, SpecDieName); 1490 FuncAbsDie2.addAttribute(DW_AT_linkage_name, DW_FORM_strp, SpecLinkageName); 1491 FuncAbsDie.addAttribute(DW_AT_specification, DW_FORM_ref4, FuncSpecDie); 1492 FuncAbsDie.addAttribute(DW_AT_abstract_origin, DW_FORM_ref4, FuncAbsDie2); 1493 FuncDie.addAttribute(DW_AT_abstract_origin, DW_FORM_ref4, FuncAbsDie); 1494 VarAbsDie.addAttribute(DW_AT_name, DW_FORM_strp, AbsDieName); 1495 VarDie.addAttribute(DW_AT_abstract_origin, DW_FORM_ref4, VarAbsDie); 1496 } 1497 1498 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1499 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1500 EXPECT_TRUE((bool)Obj); 1501 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1502 1503 // Verify the number of compile units is correct. 1504 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1505 EXPECT_EQ(NumCUs, 1u); 1506 DWARFCompileUnit *U = 1507 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1508 1509 // Get the compile unit DIE is valid. 1510 auto CUDie = U->getUnitDIE(false); 1511 EXPECT_TRUE(CUDie.isValid()); 1512 1513 auto FuncSpecDie = CUDie.getFirstChild(); 1514 auto FuncAbsDie = FuncSpecDie.getSibling(); 1515 auto FuncAbsDie2 = FuncAbsDie.getSibling(); 1516 auto FuncDie = FuncAbsDie2.getSibling(); 1517 auto VarAbsDie = FuncDie.getSibling(); 1518 auto VarDie = VarAbsDie.getSibling(); 1519 1520 // Make sure we can't extract the name from the specification die when using 1521 // DWARFDie::find() since it won't check the DW_AT_specification DIE. 1522 EXPECT_FALSE(FuncDie.find(DW_AT_name)); 1523 1524 // Make sure we can extract the name from the specification die when using 1525 // DWARFDie::findRecursively() since it should recurse through the 1526 // DW_AT_specification DIE. 1527 auto NameOpt = FuncDie.findRecursively(DW_AT_name); 1528 EXPECT_TRUE(NameOpt); 1529 // Test the dwarf::toString() helper function. 1530 auto StringOpt = toString(NameOpt); 1531 EXPECT_TRUE(StringOpt); 1532 EXPECT_EQ(SpecDieName, StringOpt.getValueOr(nullptr)); 1533 // Test the dwarf::toString() helper function with a default value specified. 1534 EXPECT_EQ(SpecDieName, toString(NameOpt, nullptr)); 1535 1536 auto LinkageNameOpt = FuncDie.findRecursively(DW_AT_linkage_name); 1537 EXPECT_EQ(SpecLinkageName, toString(LinkageNameOpt).getValueOr(nullptr)); 1538 1539 // Make sure we can't extract the name from the abstract origin die when using 1540 // DWARFDie::find() since it won't check the DW_AT_abstract_origin DIE. 1541 EXPECT_FALSE(VarDie.find(DW_AT_name)); 1542 1543 // Make sure we can extract the name from the abstract origin die when using 1544 // DWARFDie::findRecursively() since it should recurse through the 1545 // DW_AT_abstract_origin DIE. 1546 NameOpt = VarDie.findRecursively(DW_AT_name); 1547 EXPECT_TRUE(NameOpt); 1548 // Test the dwarf::toString() helper function. 1549 StringOpt = toString(NameOpt); 1550 EXPECT_TRUE(StringOpt); 1551 EXPECT_EQ(AbsDieName, StringOpt.getValueOr(nullptr)); 1552 } 1553 1554 TEST(DWARFDebugInfo, TestDwarfToFunctions) { 1555 // Test all of the dwarf::toXXX functions that take a 1556 // Optional<DWARFFormValue> and extract the values from it. 1557 uint64_t InvalidU64 = 0xBADBADBADBADBADB; 1558 int64_t InvalidS64 = 0xBADBADBADBADBADB; 1559 1560 // First test that we don't get valid values back when using an optional with 1561 // no value. 1562 Optional<DWARFFormValue> FormValOpt1 = DWARFFormValue(); 1563 EXPECT_FALSE(toString(FormValOpt1).hasValue()); 1564 EXPECT_FALSE(toUnsigned(FormValOpt1).hasValue()); 1565 EXPECT_FALSE(toReference(FormValOpt1).hasValue()); 1566 EXPECT_FALSE(toSigned(FormValOpt1).hasValue()); 1567 EXPECT_FALSE(toAddress(FormValOpt1).hasValue()); 1568 EXPECT_FALSE(toSectionOffset(FormValOpt1).hasValue()); 1569 EXPECT_FALSE(toBlock(FormValOpt1).hasValue()); 1570 EXPECT_EQ(nullptr, toString(FormValOpt1, nullptr)); 1571 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt1, InvalidU64)); 1572 EXPECT_EQ(InvalidU64, toReference(FormValOpt1, InvalidU64)); 1573 EXPECT_EQ(InvalidU64, toAddress(FormValOpt1, InvalidU64)); 1574 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt1, InvalidU64)); 1575 EXPECT_EQ(InvalidS64, toSigned(FormValOpt1, InvalidS64)); 1576 1577 // Test successful and unsuccessful address decoding. 1578 uint64_t Address = 0x100000000ULL; 1579 Optional<DWARFFormValue> FormValOpt2 = 1580 DWARFFormValue::createFromUValue(DW_FORM_addr, Address); 1581 1582 EXPECT_FALSE(toString(FormValOpt2).hasValue()); 1583 EXPECT_FALSE(toUnsigned(FormValOpt2).hasValue()); 1584 EXPECT_FALSE(toReference(FormValOpt2).hasValue()); 1585 EXPECT_FALSE(toSigned(FormValOpt2).hasValue()); 1586 EXPECT_TRUE(toAddress(FormValOpt2).hasValue()); 1587 EXPECT_FALSE(toSectionOffset(FormValOpt2).hasValue()); 1588 EXPECT_FALSE(toBlock(FormValOpt2).hasValue()); 1589 EXPECT_EQ(nullptr, toString(FormValOpt2, nullptr)); 1590 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt2, InvalidU64)); 1591 EXPECT_EQ(InvalidU64, toReference(FormValOpt2, InvalidU64)); 1592 EXPECT_EQ(Address, toAddress(FormValOpt2, InvalidU64)); 1593 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt2, InvalidU64)); 1594 EXPECT_EQ(InvalidS64, toSigned(FormValOpt2, InvalidU64)); 1595 1596 // Test successful and unsuccessful unsigned constant decoding. 1597 uint64_t UData8 = 0x1020304050607080ULL; 1598 Optional<DWARFFormValue> FormValOpt3 = 1599 DWARFFormValue::createFromUValue(DW_FORM_udata, UData8); 1600 1601 EXPECT_FALSE(toString(FormValOpt3).hasValue()); 1602 EXPECT_TRUE(toUnsigned(FormValOpt3).hasValue()); 1603 EXPECT_FALSE(toReference(FormValOpt3).hasValue()); 1604 EXPECT_TRUE(toSigned(FormValOpt3).hasValue()); 1605 EXPECT_FALSE(toAddress(FormValOpt3).hasValue()); 1606 EXPECT_FALSE(toSectionOffset(FormValOpt3).hasValue()); 1607 EXPECT_FALSE(toBlock(FormValOpt3).hasValue()); 1608 EXPECT_EQ(nullptr, toString(FormValOpt3, nullptr)); 1609 EXPECT_EQ(UData8, toUnsigned(FormValOpt3, InvalidU64)); 1610 EXPECT_EQ(InvalidU64, toReference(FormValOpt3, InvalidU64)); 1611 EXPECT_EQ(InvalidU64, toAddress(FormValOpt3, InvalidU64)); 1612 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt3, InvalidU64)); 1613 EXPECT_EQ((int64_t)UData8, toSigned(FormValOpt3, InvalidU64)); 1614 1615 // Test successful and unsuccessful reference decoding. 1616 uint32_t RefData = 0x11223344U; 1617 Optional<DWARFFormValue> FormValOpt4 = 1618 DWARFFormValue::createFromUValue(DW_FORM_ref_addr, RefData); 1619 1620 EXPECT_FALSE(toString(FormValOpt4).hasValue()); 1621 EXPECT_FALSE(toUnsigned(FormValOpt4).hasValue()); 1622 EXPECT_TRUE(toReference(FormValOpt4).hasValue()); 1623 EXPECT_FALSE(toSigned(FormValOpt4).hasValue()); 1624 EXPECT_FALSE(toAddress(FormValOpt4).hasValue()); 1625 EXPECT_FALSE(toSectionOffset(FormValOpt4).hasValue()); 1626 EXPECT_FALSE(toBlock(FormValOpt4).hasValue()); 1627 EXPECT_EQ(nullptr, toString(FormValOpt4, nullptr)); 1628 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt4, InvalidU64)); 1629 EXPECT_EQ(RefData, toReference(FormValOpt4, InvalidU64)); 1630 EXPECT_EQ(InvalidU64, toAddress(FormValOpt4, InvalidU64)); 1631 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt4, InvalidU64)); 1632 EXPECT_EQ(InvalidS64, toSigned(FormValOpt4, InvalidU64)); 1633 1634 // Test successful and unsuccessful signed constant decoding. 1635 int64_t SData8 = 0x1020304050607080ULL; 1636 Optional<DWARFFormValue> FormValOpt5 = 1637 DWARFFormValue::createFromSValue(DW_FORM_udata, SData8); 1638 1639 EXPECT_FALSE(toString(FormValOpt5).hasValue()); 1640 EXPECT_TRUE(toUnsigned(FormValOpt5).hasValue()); 1641 EXPECT_FALSE(toReference(FormValOpt5).hasValue()); 1642 EXPECT_TRUE(toSigned(FormValOpt5).hasValue()); 1643 EXPECT_FALSE(toAddress(FormValOpt5).hasValue()); 1644 EXPECT_FALSE(toSectionOffset(FormValOpt5).hasValue()); 1645 EXPECT_FALSE(toBlock(FormValOpt5).hasValue()); 1646 EXPECT_EQ(nullptr, toString(FormValOpt5, nullptr)); 1647 EXPECT_EQ((uint64_t)SData8, toUnsigned(FormValOpt5, InvalidU64)); 1648 EXPECT_EQ(InvalidU64, toReference(FormValOpt5, InvalidU64)); 1649 EXPECT_EQ(InvalidU64, toAddress(FormValOpt5, InvalidU64)); 1650 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt5, InvalidU64)); 1651 EXPECT_EQ(SData8, toSigned(FormValOpt5, InvalidU64)); 1652 1653 // Test successful and unsuccessful block decoding. 1654 uint8_t Data[] = { 2, 3, 4 }; 1655 ArrayRef<uint8_t> Array(Data); 1656 Optional<DWARFFormValue> FormValOpt6 = 1657 DWARFFormValue::createFromBlockValue(DW_FORM_block1, Array); 1658 1659 EXPECT_FALSE(toString(FormValOpt6).hasValue()); 1660 EXPECT_FALSE(toUnsigned(FormValOpt6).hasValue()); 1661 EXPECT_FALSE(toReference(FormValOpt6).hasValue()); 1662 EXPECT_FALSE(toSigned(FormValOpt6).hasValue()); 1663 EXPECT_FALSE(toAddress(FormValOpt6).hasValue()); 1664 EXPECT_FALSE(toSectionOffset(FormValOpt6).hasValue()); 1665 auto BlockOpt = toBlock(FormValOpt6); 1666 EXPECT_TRUE(BlockOpt.hasValue()); 1667 EXPECT_EQ(*BlockOpt, Array); 1668 EXPECT_EQ(nullptr, toString(FormValOpt6, nullptr)); 1669 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt6, InvalidU64)); 1670 EXPECT_EQ(InvalidU64, toReference(FormValOpt6, InvalidU64)); 1671 EXPECT_EQ(InvalidU64, toAddress(FormValOpt6, InvalidU64)); 1672 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt6, InvalidU64)); 1673 EXPECT_EQ(InvalidS64, toSigned(FormValOpt6, InvalidU64)); 1674 1675 // Test 1676 } 1677 1678 TEST(DWARFDebugInfo, TestFindAttrs) { 1679 Triple Triple = getNormalizedDefaultTargetTriple(); 1680 if (!isConfigurationSupported(Triple)) 1681 return; 1682 1683 // Test the DWARFDie::find() and DWARFDie::findRecursively() that take an 1684 // ArrayRef<dwarf::Attribute> value to make sure they work correctly. 1685 uint16_t Version = 4; 1686 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1687 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1688 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1689 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1690 1691 StringRef DieMangled("_Z3fooi"); 1692 // Scope to allow us to re-use the same DIE names 1693 { 1694 auto CUDie = CU.getUnitDIE(); 1695 auto FuncSpecDie = CUDie.addChild(DW_TAG_subprogram); 1696 auto FuncDie = CUDie.addChild(DW_TAG_subprogram); 1697 FuncSpecDie.addAttribute(DW_AT_MIPS_linkage_name, DW_FORM_strp, DieMangled); 1698 FuncDie.addAttribute(DW_AT_specification, DW_FORM_ref4, FuncSpecDie); 1699 } 1700 1701 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1702 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1703 EXPECT_TRUE((bool)Obj); 1704 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1705 1706 // Verify the number of compile units is correct. 1707 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1708 EXPECT_EQ(NumCUs, 1u); 1709 DWARFCompileUnit *U = 1710 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1711 1712 // Get the compile unit DIE is valid. 1713 auto CUDie = U->getUnitDIE(false); 1714 EXPECT_TRUE(CUDie.isValid()); 1715 1716 auto FuncSpecDie = CUDie.getFirstChild(); 1717 auto FuncDie = FuncSpecDie.getSibling(); 1718 1719 // Make sure that passing in an empty attribute list behave correctly. 1720 EXPECT_FALSE(FuncDie.find(ArrayRef<dwarf::Attribute>()).hasValue()); 1721 1722 // Make sure that passing in a list of attribute that are not contained 1723 // in the DIE returns nothing. 1724 EXPECT_FALSE(FuncDie.find({DW_AT_low_pc, DW_AT_entry_pc}).hasValue()); 1725 1726 const dwarf::Attribute Attrs[] = {DW_AT_linkage_name, 1727 DW_AT_MIPS_linkage_name}; 1728 1729 // Make sure we can't extract the linkage name attributes when using 1730 // DWARFDie::find() since it won't check the DW_AT_specification DIE. 1731 EXPECT_FALSE(FuncDie.find(Attrs).hasValue()); 1732 1733 // Make sure we can extract the name from the specification die when using 1734 // DWARFDie::findRecursively() since it should recurse through the 1735 // DW_AT_specification DIE. 1736 auto NameOpt = FuncDie.findRecursively(Attrs); 1737 EXPECT_TRUE(NameOpt.hasValue()); 1738 EXPECT_EQ(DieMangled, toString(NameOpt, "")); 1739 } 1740 1741 TEST(DWARFDebugInfo, TestImplicitConstAbbrevs) { 1742 Triple Triple = getNormalizedDefaultTargetTriple(); 1743 if (!isConfigurationSupported(Triple)) 1744 return; 1745 1746 uint16_t Version = 5; 1747 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1748 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1749 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1750 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1751 dwarfgen::DIE CUDie = CU.getUnitDIE(); 1752 const dwarf::Attribute Attr = DW_AT_lo_user; 1753 const int64_t Val1 = 42; 1754 const int64_t Val2 = 43; 1755 1756 auto FirstVal1DIE = CUDie.addChild(DW_TAG_class_type); 1757 FirstVal1DIE.addAttribute(Attr, DW_FORM_implicit_const, Val1); 1758 1759 auto SecondVal1DIE = CUDie.addChild(DW_TAG_class_type); 1760 SecondVal1DIE.addAttribute(Attr, DW_FORM_implicit_const, Val1); 1761 1762 auto Val2DIE = CUDie.addChild(DW_TAG_class_type); 1763 Val2DIE.addAttribute(Attr, DW_FORM_implicit_const, Val2); 1764 1765 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1766 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1767 EXPECT_TRUE((bool)Obj); 1768 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1769 DWARFCompileUnit *U = 1770 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1771 EXPECT_TRUE((bool)U); 1772 1773 const auto *Abbrevs = U->getAbbreviations(); 1774 EXPECT_TRUE((bool)Abbrevs); 1775 1776 // Let's find implicit_const abbrevs and verify, 1777 // that there are exactly two of them and both of them 1778 // can be dumped correctly. 1779 typedef decltype(Abbrevs->begin()) AbbrevIt; 1780 AbbrevIt Val1Abbrev = Abbrevs->end(); 1781 AbbrevIt Val2Abbrev = Abbrevs->end(); 1782 for(auto it = Abbrevs->begin(); it != Abbrevs->end(); ++it) { 1783 if (it->getNumAttributes() == 0) 1784 continue; // root abbrev for DW_TAG_compile_unit 1785 1786 auto A = it->getAttrByIndex(0); 1787 EXPECT_EQ(A, Attr); 1788 1789 auto FormValue = it->getAttributeValue(/* offset */ 0, A, *U); 1790 EXPECT_TRUE((bool)FormValue); 1791 EXPECT_EQ(FormValue->getForm(), dwarf::DW_FORM_implicit_const); 1792 1793 const auto V = FormValue->getAsSignedConstant(); 1794 EXPECT_TRUE((bool)V); 1795 1796 auto VerifyAbbrevDump = [&V](AbbrevIt it) { 1797 std::string S; 1798 llvm::raw_string_ostream OS(S); 1799 it->dump(OS); 1800 auto FormPos = OS.str().find("DW_FORM_implicit_const"); 1801 EXPECT_NE(FormPos, std::string::npos); 1802 auto ValPos = S.find_first_of("-0123456789", FormPos); 1803 EXPECT_NE(ValPos, std::string::npos); 1804 int64_t Val = std::atoll(S.substr(ValPos).c_str()); 1805 EXPECT_EQ(Val, *V); 1806 }; 1807 1808 switch(*V) { 1809 case Val1: 1810 EXPECT_EQ(Val1Abbrev, Abbrevs->end()); 1811 Val1Abbrev = it; 1812 VerifyAbbrevDump(it); 1813 break; 1814 case Val2: 1815 EXPECT_EQ(Val2Abbrev, Abbrevs->end()); 1816 Val2Abbrev = it; 1817 VerifyAbbrevDump(it); 1818 break; 1819 default: 1820 FAIL() << "Unexpected attribute value: " << *V; 1821 } 1822 } 1823 1824 // Now let's make sure that two Val1-DIEs refer to the same abbrev, 1825 // and Val2-DIE refers to another one. 1826 auto DieDG = U->getUnitDIE(false); 1827 auto it = DieDG.begin(); 1828 std::multimap<int64_t, decltype(it->getAbbreviationDeclarationPtr())> DIEs; 1829 const DWARFAbbreviationDeclaration *AbbrevPtrVal1 = nullptr; 1830 const DWARFAbbreviationDeclaration *AbbrevPtrVal2 = nullptr; 1831 for (; it != DieDG.end(); ++it) { 1832 const auto *AbbrevPtr = it->getAbbreviationDeclarationPtr(); 1833 EXPECT_TRUE((bool)AbbrevPtr); 1834 auto FormValue = it->find(Attr); 1835 EXPECT_TRUE((bool)FormValue); 1836 const auto V = FormValue->getAsSignedConstant(); 1837 EXPECT_TRUE((bool)V); 1838 switch(*V) { 1839 case Val1: 1840 AbbrevPtrVal1 = AbbrevPtr; 1841 break; 1842 case Val2: 1843 AbbrevPtrVal2 = AbbrevPtr; 1844 break; 1845 default: 1846 FAIL() << "Unexpected attribute value: " << *V; 1847 } 1848 DIEs.insert(std::make_pair(*V, AbbrevPtr)); 1849 } 1850 EXPECT_EQ(DIEs.count(Val1), 2u); 1851 EXPECT_EQ(DIEs.count(Val2), 1u); 1852 auto Val1Range = DIEs.equal_range(Val1); 1853 for (auto it = Val1Range.first; it != Val1Range.second; ++it) 1854 EXPECT_EQ(it->second, AbbrevPtrVal1); 1855 EXPECT_EQ(DIEs.find(Val2)->second, AbbrevPtrVal2); 1856 } 1857 1858 void VerifyWarning(DWARFContext &DwarfContext, StringRef Error) { 1859 SmallString<1024> Str; 1860 raw_svector_ostream Strm(Str); 1861 EXPECT_TRUE(DwarfContext.verify(Strm)); 1862 EXPECT_TRUE(Str.str().contains(Error)); 1863 } 1864 1865 void VerifyError(DWARFContext &DwarfContext, StringRef Error) { 1866 SmallString<1024> Str; 1867 raw_svector_ostream Strm(Str); 1868 EXPECT_FALSE(DwarfContext.verify(Strm)); 1869 EXPECT_TRUE(Str.str().contains(Error)); 1870 } 1871 1872 void VerifySuccess(DWARFContext &DwarfContext) { 1873 SmallString<1024> Str; 1874 raw_svector_ostream Strm(Str); 1875 EXPECT_TRUE(DwarfContext.verify(Strm)); 1876 } 1877 1878 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidCURef) { 1879 // Create a single compile unit with a single function that has a DW_AT_type 1880 // that is CU relative. The CU offset is not valid because it is larger than 1881 // the compile unit itself. 1882 1883 const char *yamldata = R"( 1884 debug_str: 1885 - '' 1886 - /tmp/main.c 1887 - main 1888 debug_abbrev: 1889 - Table: 1890 - Code: 0x00000001 1891 Tag: DW_TAG_compile_unit 1892 Children: DW_CHILDREN_yes 1893 Attributes: 1894 - Attribute: DW_AT_name 1895 Form: DW_FORM_strp 1896 - Code: 0x00000002 1897 Tag: DW_TAG_subprogram 1898 Children: DW_CHILDREN_no 1899 Attributes: 1900 - Attribute: DW_AT_name 1901 Form: DW_FORM_strp 1902 - Attribute: DW_AT_type 1903 Form: DW_FORM_ref4 1904 debug_info: 1905 - Length: 22 1906 Version: 4 1907 AbbrOffset: 0 1908 AddrSize: 8 1909 Entries: 1910 - AbbrCode: 0x00000001 1911 Values: 1912 - Value: 0x0000000000000001 1913 - AbbrCode: 0x00000002 1914 Values: 1915 - Value: 0x000000000000000D 1916 - Value: 0x0000000000001234 1917 - AbbrCode: 0x00000000 1918 Values: 1919 )"; 1920 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 1921 ASSERT_TRUE((bool)ErrOrSections); 1922 std::unique_ptr<DWARFContext> DwarfContext = 1923 DWARFContext::create(*ErrOrSections, 8); 1924 VerifyError(*DwarfContext, "error: DW_FORM_ref4 CU offset 0x00001234 is " 1925 "invalid (must be less than CU size of " 1926 "0x0000001a):"); 1927 } 1928 1929 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidRefAddr) { 1930 // Create a single compile unit with a single function that has an invalid 1931 // DW_AT_type with an invalid .debug_info offset in its DW_FORM_ref_addr. 1932 const char *yamldata = R"( 1933 debug_str: 1934 - '' 1935 - /tmp/main.c 1936 - main 1937 debug_abbrev: 1938 - Table: 1939 - Code: 0x00000001 1940 Tag: DW_TAG_compile_unit 1941 Children: DW_CHILDREN_yes 1942 Attributes: 1943 - Attribute: DW_AT_name 1944 Form: DW_FORM_strp 1945 - Code: 0x00000002 1946 Tag: DW_TAG_subprogram 1947 Children: DW_CHILDREN_no 1948 Attributes: 1949 - Attribute: DW_AT_name 1950 Form: DW_FORM_strp 1951 - Attribute: DW_AT_type 1952 Form: DW_FORM_ref_addr 1953 debug_info: 1954 - Length: 22 1955 Version: 4 1956 AbbrOffset: 0 1957 AddrSize: 8 1958 Entries: 1959 - AbbrCode: 0x00000001 1960 Values: 1961 - Value: 0x0000000000000001 1962 - AbbrCode: 0x00000002 1963 Values: 1964 - Value: 0x000000000000000D 1965 - Value: 0x0000000000001234 1966 - AbbrCode: 0x00000000 1967 Values: 1968 )"; 1969 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 1970 ASSERT_TRUE((bool)ErrOrSections); 1971 std::unique_ptr<DWARFContext> DwarfContext = 1972 DWARFContext::create(*ErrOrSections, 8); 1973 VerifyError(*DwarfContext, 1974 "error: DW_FORM_ref_addr offset beyond .debug_info bounds:"); 1975 } 1976 1977 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidRanges) { 1978 // Create a single compile unit with a DW_AT_ranges whose section offset 1979 // isn't valid. 1980 const char *yamldata = R"( 1981 debug_str: 1982 - '' 1983 - /tmp/main.c 1984 debug_abbrev: 1985 - Table: 1986 - Code: 0x00000001 1987 Tag: DW_TAG_compile_unit 1988 Children: DW_CHILDREN_no 1989 Attributes: 1990 - Attribute: DW_AT_name 1991 Form: DW_FORM_strp 1992 - Attribute: DW_AT_ranges 1993 Form: DW_FORM_sec_offset 1994 debug_info: 1995 - Length: 16 1996 Version: 4 1997 AbbrOffset: 0 1998 AddrSize: 8 1999 Entries: 2000 - AbbrCode: 0x00000001 2001 Values: 2002 - Value: 0x0000000000000001 2003 - Value: 0x0000000000001000 2004 2005 )"; 2006 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2007 ASSERT_TRUE((bool)ErrOrSections); 2008 std::unique_ptr<DWARFContext> DwarfContext = 2009 DWARFContext::create(*ErrOrSections, 8); 2010 VerifyError( 2011 *DwarfContext, 2012 "error: DW_AT_ranges offset is beyond .debug_ranges bounds: 0x00001000"); 2013 } 2014 2015 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidRnglists) { 2016 // Create a single compile unit with a DW_AT_ranges whose section offset 2017 // isn't valid. 2018 const char *yamldata = R"( 2019 debug_str: 2020 - '' 2021 - /tmp/main.c 2022 debug_abbrev: 2023 - Table: 2024 - Code: 0x00000001 2025 Tag: DW_TAG_compile_unit 2026 Children: DW_CHILDREN_no 2027 Attributes: 2028 - Attribute: DW_AT_name 2029 Form: DW_FORM_strp 2030 - Attribute: DW_AT_ranges 2031 Form: DW_FORM_sec_offset 2032 debug_info: 2033 - Length: 17 2034 Version: 5 2035 UnitType: DW_UT_compile 2036 AbbrOffset: 0 2037 AddrSize: 8 2038 Entries: 2039 - AbbrCode: 0x00000001 2040 Values: 2041 - Value: 0x0000000000000001 2042 - Value: 0x0000000000001000 2043 2044 )"; 2045 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2046 ASSERT_TRUE((bool)ErrOrSections); 2047 std::unique_ptr<DWARFContext> DwarfContext = 2048 DWARFContext::create(*ErrOrSections, 8); 2049 VerifyError(*DwarfContext, "error: DW_AT_ranges offset is beyond " 2050 ".debug_rnglists bounds: 0x00001000"); 2051 } 2052 2053 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidStmtList) { 2054 // Create a single compile unit with a DW_AT_stmt_list whose section offset 2055 // isn't valid. 2056 const char *yamldata = R"( 2057 debug_str: 2058 - '' 2059 - /tmp/main.c 2060 debug_abbrev: 2061 - Table: 2062 - Code: 0x00000001 2063 Tag: DW_TAG_compile_unit 2064 Children: DW_CHILDREN_no 2065 Attributes: 2066 - Attribute: DW_AT_name 2067 Form: DW_FORM_strp 2068 - Attribute: DW_AT_stmt_list 2069 Form: DW_FORM_sec_offset 2070 debug_info: 2071 - Length: 16 2072 Version: 4 2073 AbbrOffset: 0 2074 AddrSize: 8 2075 Entries: 2076 - AbbrCode: 0x00000001 2077 Values: 2078 - Value: 0x0000000000000001 2079 - Value: 0x0000000000001000 2080 2081 )"; 2082 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2083 ASSERT_TRUE((bool)ErrOrSections); 2084 std::unique_ptr<DWARFContext> DwarfContext = 2085 DWARFContext::create(*ErrOrSections, 8); 2086 VerifyError( 2087 *DwarfContext, 2088 "error: DW_AT_stmt_list offset is beyond .debug_line bounds: 0x00001000"); 2089 } 2090 2091 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidStrp) { 2092 // Create a single compile unit with a single function that has an invalid 2093 // DW_FORM_strp for the DW_AT_name. 2094 const char *yamldata = R"( 2095 debug_str: 2096 - '' 2097 debug_abbrev: 2098 - Table: 2099 - Code: 0x00000001 2100 Tag: DW_TAG_compile_unit 2101 Children: DW_CHILDREN_no 2102 Attributes: 2103 - Attribute: DW_AT_name 2104 Form: DW_FORM_strp 2105 debug_info: 2106 - Length: 12 2107 Version: 4 2108 AbbrOffset: 0 2109 AddrSize: 8 2110 Entries: 2111 - AbbrCode: 0x00000001 2112 Values: 2113 - Value: 0x0000000000001234 2114 )"; 2115 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2116 ASSERT_TRUE((bool)ErrOrSections); 2117 std::unique_ptr<DWARFContext> DwarfContext = 2118 DWARFContext::create(*ErrOrSections, 8); 2119 VerifyError(*DwarfContext, 2120 "error: DW_FORM_strp offset beyond .debug_str bounds:"); 2121 } 2122 2123 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidRefAddrBetween) { 2124 // Create a single compile unit with a single function that has a DW_AT_type 2125 // with a valid .debug_info offset, but the offset is between two DIEs. 2126 const char *yamldata = R"( 2127 debug_str: 2128 - '' 2129 - /tmp/main.c 2130 - main 2131 debug_abbrev: 2132 - Table: 2133 - Code: 0x00000001 2134 Tag: DW_TAG_compile_unit 2135 Children: DW_CHILDREN_yes 2136 Attributes: 2137 - Attribute: DW_AT_name 2138 Form: DW_FORM_strp 2139 - Code: 0x00000002 2140 Tag: DW_TAG_subprogram 2141 Children: DW_CHILDREN_no 2142 Attributes: 2143 - Attribute: DW_AT_name 2144 Form: DW_FORM_strp 2145 - Attribute: DW_AT_type 2146 Form: DW_FORM_ref_addr 2147 debug_info: 2148 - Length: 22 2149 Version: 4 2150 AbbrOffset: 0 2151 AddrSize: 8 2152 Entries: 2153 - AbbrCode: 0x00000001 2154 Values: 2155 - Value: 0x0000000000000001 2156 - AbbrCode: 0x00000002 2157 Values: 2158 - Value: 0x000000000000000D 2159 - Value: 0x0000000000000011 2160 - AbbrCode: 0x00000000 2161 Values: 2162 )"; 2163 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2164 ASSERT_TRUE((bool)ErrOrSections); 2165 std::unique_ptr<DWARFContext> DwarfContext = 2166 DWARFContext::create(*ErrOrSections, 8); 2167 VerifyError( 2168 *DwarfContext, 2169 "error: invalid DIE reference 0x00000011. Offset is in between DIEs:"); 2170 } 2171 2172 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidLineSequence) { 2173 // Create a single compile unit whose line table has a sequence in it where 2174 // the address decreases. 2175 StringRef yamldata = R"( 2176 debug_str: 2177 - '' 2178 - /tmp/main.c 2179 debug_abbrev: 2180 - Table: 2181 - Code: 0x00000001 2182 Tag: DW_TAG_compile_unit 2183 Children: DW_CHILDREN_no 2184 Attributes: 2185 - Attribute: DW_AT_name 2186 Form: DW_FORM_strp 2187 - Attribute: DW_AT_stmt_list 2188 Form: DW_FORM_sec_offset 2189 debug_info: 2190 - Length: 16 2191 Version: 4 2192 AbbrOffset: 0 2193 AddrSize: 8 2194 Entries: 2195 - AbbrCode: 0x00000001 2196 Values: 2197 - Value: 0x0000000000000001 2198 - Value: 0x0000000000000000 2199 debug_line: 2200 - Length: 68 2201 Version: 2 2202 PrologueLength: 34 2203 MinInstLength: 1 2204 DefaultIsStmt: 1 2205 LineBase: 251 2206 LineRange: 14 2207 OpcodeBase: 13 2208 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2209 IncludeDirs: 2210 - /tmp 2211 Files: 2212 - Name: main.c 2213 DirIdx: 1 2214 ModTime: 0 2215 Length: 0 2216 Opcodes: 2217 - Opcode: DW_LNS_extended_op 2218 ExtLen: 9 2219 SubOpcode: DW_LNE_set_address 2220 Data: 4112 2221 - Opcode: DW_LNS_advance_line 2222 SData: 9 2223 Data: 4112 2224 - Opcode: DW_LNS_copy 2225 Data: 4112 2226 - Opcode: DW_LNS_advance_pc 2227 Data: 18446744073709551600 2228 - Opcode: DW_LNS_extended_op 2229 ExtLen: 1 2230 SubOpcode: DW_LNE_end_sequence 2231 Data: 18446744073709551600 2232 )"; 2233 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2234 ASSERT_TRUE((bool)ErrOrSections); 2235 std::unique_ptr<DWARFContext> DwarfContext = 2236 DWARFContext::create(*ErrOrSections, 8); 2237 VerifyError(*DwarfContext, "error: .debug_line[0x00000000] row[1] decreases " 2238 "in address from previous row:"); 2239 } 2240 2241 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidLineFileIndex) { 2242 // Create a single compile unit whose line table has a line table row with 2243 // an invalid file index. 2244 StringRef yamldata = R"( 2245 debug_str: 2246 - '' 2247 - /tmp/main.c 2248 debug_abbrev: 2249 - Table: 2250 - Code: 0x00000001 2251 Tag: DW_TAG_compile_unit 2252 Children: DW_CHILDREN_no 2253 Attributes: 2254 - Attribute: DW_AT_name 2255 Form: DW_FORM_strp 2256 - Attribute: DW_AT_stmt_list 2257 Form: DW_FORM_sec_offset 2258 debug_info: 2259 - Length: 16 2260 Version: 4 2261 AbbrOffset: 0 2262 AddrSize: 8 2263 Entries: 2264 - AbbrCode: 0x00000001 2265 Values: 2266 - Value: 0x0000000000000001 2267 - Value: 0x0000000000000000 2268 debug_line: 2269 - Length: 61 2270 Version: 2 2271 PrologueLength: 34 2272 MinInstLength: 1 2273 DefaultIsStmt: 1 2274 LineBase: 251 2275 LineRange: 14 2276 OpcodeBase: 13 2277 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2278 IncludeDirs: 2279 - /tmp 2280 Files: 2281 - Name: main.c 2282 DirIdx: 1 2283 ModTime: 0 2284 Length: 0 2285 Opcodes: 2286 - Opcode: DW_LNS_extended_op 2287 ExtLen: 9 2288 SubOpcode: DW_LNE_set_address 2289 Data: 4096 2290 - Opcode: DW_LNS_advance_line 2291 SData: 9 2292 Data: 4096 2293 - Opcode: DW_LNS_copy 2294 Data: 4096 2295 - Opcode: DW_LNS_advance_pc 2296 Data: 16 2297 - Opcode: DW_LNS_set_file 2298 Data: 5 2299 - Opcode: DW_LNS_extended_op 2300 ExtLen: 1 2301 SubOpcode: DW_LNE_end_sequence 2302 Data: 5 2303 )"; 2304 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2305 ASSERT_TRUE((bool)ErrOrSections); 2306 std::unique_ptr<DWARFContext> DwarfContext = 2307 DWARFContext::create(*ErrOrSections, 8); 2308 VerifyError(*DwarfContext, "error: .debug_line[0x00000000][1] has invalid " 2309 "file index 5 (valid values are [1,1]):"); 2310 } 2311 2312 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidLineTablePorlogueDirIndex) { 2313 // Create a single compile unit whose line table has a prologue with an 2314 // invalid dir index. 2315 StringRef yamldata = R"( 2316 debug_str: 2317 - '' 2318 - /tmp/main.c 2319 debug_abbrev: 2320 - Table: 2321 - Code: 0x00000001 2322 Tag: DW_TAG_compile_unit 2323 Children: DW_CHILDREN_no 2324 Attributes: 2325 - Attribute: DW_AT_name 2326 Form: DW_FORM_strp 2327 - Attribute: DW_AT_stmt_list 2328 Form: DW_FORM_sec_offset 2329 debug_info: 2330 - Length: 16 2331 Version: 4 2332 AbbrOffset: 0 2333 AddrSize: 8 2334 Entries: 2335 - AbbrCode: 0x00000001 2336 Values: 2337 - Value: 0x0000000000000001 2338 - Value: 0x0000000000000000 2339 debug_line: 2340 - Length: 61 2341 Version: 2 2342 PrologueLength: 34 2343 MinInstLength: 1 2344 DefaultIsStmt: 1 2345 LineBase: 251 2346 LineRange: 14 2347 OpcodeBase: 13 2348 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2349 IncludeDirs: 2350 - /tmp 2351 Files: 2352 - Name: main.c 2353 DirIdx: 2 2354 ModTime: 0 2355 Length: 0 2356 Opcodes: 2357 - Opcode: DW_LNS_extended_op 2358 ExtLen: 9 2359 SubOpcode: DW_LNE_set_address 2360 Data: 4096 2361 - Opcode: DW_LNS_advance_line 2362 SData: 9 2363 Data: 4096 2364 - Opcode: DW_LNS_copy 2365 Data: 4096 2366 - Opcode: DW_LNS_advance_pc 2367 Data: 16 2368 - Opcode: DW_LNS_set_file 2369 Data: 1 2370 - Opcode: DW_LNS_extended_op 2371 ExtLen: 1 2372 SubOpcode: DW_LNE_end_sequence 2373 Data: 1 2374 )"; 2375 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2376 ASSERT_TRUE((bool)ErrOrSections); 2377 std::unique_ptr<DWARFContext> DwarfContext = 2378 DWARFContext::create(*ErrOrSections, 8); 2379 VerifyError(*DwarfContext, 2380 "error: .debug_line[0x00000000].prologue." 2381 "file_names[1].dir_idx contains an invalid index: 2"); 2382 } 2383 2384 TEST(DWARFDebugInfo, TestDwarfVerifyDuplicateFileWarning) { 2385 // Create a single compile unit whose line table has a prologue with an 2386 // invalid dir index. 2387 StringRef yamldata = R"( 2388 debug_str: 2389 - '' 2390 - /tmp/main.c 2391 debug_abbrev: 2392 - Table: 2393 - Code: 0x00000001 2394 Tag: DW_TAG_compile_unit 2395 Children: DW_CHILDREN_no 2396 Attributes: 2397 - Attribute: DW_AT_name 2398 Form: DW_FORM_strp 2399 - Attribute: DW_AT_stmt_list 2400 Form: DW_FORM_sec_offset 2401 debug_info: 2402 - Length: 16 2403 Version: 4 2404 AbbrOffset: 0 2405 AddrSize: 8 2406 Entries: 2407 - AbbrCode: 0x00000001 2408 Values: 2409 - Value: 0x0000000000000001 2410 - Value: 0x0000000000000000 2411 debug_line: 2412 - Length: 71 2413 Version: 2 2414 PrologueLength: 44 2415 MinInstLength: 1 2416 DefaultIsStmt: 1 2417 LineBase: 251 2418 LineRange: 14 2419 OpcodeBase: 13 2420 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2421 IncludeDirs: 2422 - /tmp 2423 Files: 2424 - Name: main.c 2425 DirIdx: 1 2426 ModTime: 0 2427 Length: 0 2428 - Name: main.c 2429 DirIdx: 1 2430 ModTime: 0 2431 Length: 0 2432 Opcodes: 2433 - Opcode: DW_LNS_extended_op 2434 ExtLen: 9 2435 SubOpcode: DW_LNE_set_address 2436 Data: 4096 2437 - Opcode: DW_LNS_advance_line 2438 SData: 9 2439 Data: 4096 2440 - Opcode: DW_LNS_copy 2441 Data: 4096 2442 - Opcode: DW_LNS_advance_pc 2443 Data: 16 2444 - Opcode: DW_LNS_set_file 2445 Data: 1 2446 - Opcode: DW_LNS_extended_op 2447 ExtLen: 1 2448 SubOpcode: DW_LNE_end_sequence 2449 Data: 2 2450 )"; 2451 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2452 ASSERT_TRUE((bool)ErrOrSections); 2453 std::unique_ptr<DWARFContext> DwarfContext = 2454 DWARFContext::create(*ErrOrSections, 8); 2455 VerifyWarning(*DwarfContext, 2456 "warning: .debug_line[0x00000000].prologue.file_names[2] is " 2457 "a duplicate of file_names[1]"); 2458 } 2459 2460 TEST(DWARFDebugInfo, TestDwarfVerifyCUDontShareLineTable) { 2461 // Create a two compile units where both compile units share the same 2462 // DW_AT_stmt_list value and verify we report the error correctly. 2463 StringRef yamldata = R"( 2464 debug_str: 2465 - '' 2466 - /tmp/main.c 2467 - /tmp/foo.c 2468 debug_abbrev: 2469 - Table: 2470 - Code: 0x00000001 2471 Tag: DW_TAG_compile_unit 2472 Children: DW_CHILDREN_no 2473 Attributes: 2474 - Attribute: DW_AT_name 2475 Form: DW_FORM_strp 2476 - Attribute: DW_AT_stmt_list 2477 Form: DW_FORM_sec_offset 2478 debug_info: 2479 - Length: 16 2480 Version: 4 2481 AbbrOffset: 0 2482 AddrSize: 8 2483 Entries: 2484 - AbbrCode: 0x00000001 2485 Values: 2486 - Value: 0x0000000000000001 2487 - Value: 0x0000000000000000 2488 - Length: 16 2489 Version: 4 2490 AbbrevTableID: 0 2491 AbbrOffset: 0 2492 AddrSize: 8 2493 Entries: 2494 - AbbrCode: 0x00000001 2495 Values: 2496 - Value: 0x000000000000000D 2497 - Value: 0x0000000000000000 2498 debug_line: 2499 - Length: 60 2500 Version: 2 2501 PrologueLength: 34 2502 MinInstLength: 1 2503 DefaultIsStmt: 1 2504 LineBase: 251 2505 LineRange: 14 2506 OpcodeBase: 13 2507 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2508 IncludeDirs: 2509 - /tmp 2510 Files: 2511 - Name: main.c 2512 DirIdx: 1 2513 ModTime: 0 2514 Length: 0 2515 Opcodes: 2516 - Opcode: DW_LNS_extended_op 2517 ExtLen: 9 2518 SubOpcode: DW_LNE_set_address 2519 Data: 4096 2520 - Opcode: DW_LNS_advance_line 2521 SData: 9 2522 Data: 4096 2523 - Opcode: DW_LNS_copy 2524 Data: 4096 2525 - Opcode: DW_LNS_advance_pc 2526 Data: 256 2527 - Opcode: DW_LNS_extended_op 2528 ExtLen: 1 2529 SubOpcode: DW_LNE_end_sequence 2530 Data: 256 2531 )"; 2532 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2533 ASSERT_TRUE((bool)ErrOrSections); 2534 std::unique_ptr<DWARFContext> DwarfContext = 2535 DWARFContext::create(*ErrOrSections, 8); 2536 VerifyError(*DwarfContext, 2537 "error: two compile unit DIEs, 0x0000000b and " 2538 "0x0000001f, have the same DW_AT_stmt_list section " 2539 "offset:"); 2540 } 2541 2542 TEST(DWARFDebugInfo, TestErrorReporting) { 2543 Triple Triple("x86_64-pc-linux"); 2544 if (!isConfigurationSupported(Triple)) 2545 return; 2546 2547 auto ExpectedDG = dwarfgen::Generator::create(Triple, 4 /*DwarfVersion*/); 2548 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 2549 dwarfgen::Generator *DG = ExpectedDG.get().get(); 2550 AsmPrinter *AP = DG->getAsmPrinter(); 2551 MCContext *MC = DG->getMCContext(); 2552 2553 // Emit two compressed sections with broken headers. 2554 AP->OutStreamer->SwitchSection( 2555 MC->getELFSection(".zdebug_foo", 0 /*Type*/, 0 /*Flags*/)); 2556 AP->OutStreamer->emitBytes("0"); 2557 AP->OutStreamer->SwitchSection( 2558 MC->getELFSection(".zdebug_bar", 0 /*Type*/, 0 /*Flags*/)); 2559 AP->OutStreamer->emitBytes("0"); 2560 2561 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 2562 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 2563 EXPECT_TRUE((bool)Obj); 2564 2565 // DWARFContext parses whole file and finds the two errors we expect. 2566 int Errors = 0; 2567 std::unique_ptr<DWARFContext> Ctx1 = 2568 DWARFContext::create(**Obj, nullptr, "", [&](Error E) { 2569 ++Errors; 2570 consumeError(std::move(E)); 2571 }); 2572 EXPECT_TRUE(Errors == 2); 2573 } 2574 2575 TEST(DWARFDebugInfo, TestDwarfVerifyCURangesIncomplete) { 2576 // Create a single compile unit with a single function. The compile 2577 // unit has a DW_AT_ranges attribute that doesn't fully contain the 2578 // address range of the function. The verification should fail due to 2579 // the CU ranges not containing all of the address ranges of all of the 2580 // functions. 2581 StringRef yamldata = R"( 2582 debug_str: 2583 - '' 2584 - /tmp/main.c 2585 debug_abbrev: 2586 - Table: 2587 - Code: 0x00000001 2588 Tag: DW_TAG_compile_unit 2589 Children: DW_CHILDREN_yes 2590 Attributes: 2591 - Attribute: DW_AT_low_pc 2592 Form: DW_FORM_addr 2593 - Attribute: DW_AT_high_pc 2594 Form: DW_FORM_addr 2595 - Attribute: DW_AT_name 2596 Form: DW_FORM_strp 2597 - Code: 0x00000002 2598 Tag: DW_TAG_subprogram 2599 Children: DW_CHILDREN_no 2600 Attributes: 2601 - Attribute: DW_AT_low_pc 2602 Form: DW_FORM_addr 2603 - Attribute: DW_AT_high_pc 2604 Form: DW_FORM_addr 2605 debug_info: 2606 - Length: 46 2607 Version: 4 2608 AbbrOffset: 0 2609 AddrSize: 8 2610 Entries: 2611 - AbbrCode: 0x00000001 2612 Values: 2613 - Value: 0x0000000000001000 2614 - Value: 0x0000000000001500 2615 - Value: 0x0000000000000001 2616 - AbbrCode: 0x00000002 2617 Values: 2618 - Value: 0x0000000000001000 2619 - Value: 0x0000000000002000 2620 - AbbrCode: 0x00000000 2621 Values: 2622 )"; 2623 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2624 ASSERT_TRUE((bool)ErrOrSections); 2625 std::unique_ptr<DWARFContext> DwarfContext = 2626 DWARFContext::create(*ErrOrSections, 8); 2627 VerifyError(*DwarfContext, "error: DIE address ranges are not " 2628 "contained in its parent's ranges:"); 2629 } 2630 2631 TEST(DWARFDebugInfo, TestDwarfVerifyLexicalBlockRanges) { 2632 // Create a single compile unit with a single function that has a lexical 2633 // block whose address range is not contained in the function address range. 2634 StringRef yamldata = R"( 2635 debug_str: 2636 - '' 2637 - /tmp/main.c 2638 - main 2639 debug_abbrev: 2640 - Table: 2641 - Code: 0x00000001 2642 Tag: DW_TAG_compile_unit 2643 Children: DW_CHILDREN_yes 2644 Attributes: 2645 - Attribute: DW_AT_name 2646 Form: DW_FORM_strp 2647 - Code: 0x00000002 2648 Tag: DW_TAG_subprogram 2649 Children: DW_CHILDREN_yes 2650 Attributes: 2651 - Attribute: DW_AT_name 2652 Form: DW_FORM_strp 2653 - Attribute: DW_AT_low_pc 2654 Form: DW_FORM_addr 2655 - Attribute: DW_AT_high_pc 2656 Form: DW_FORM_addr 2657 - Code: 0x00000003 2658 Tag: DW_TAG_lexical_block 2659 Children: DW_CHILDREN_no 2660 Attributes: 2661 - Attribute: DW_AT_low_pc 2662 Form: DW_FORM_addr 2663 - Attribute: DW_AT_high_pc 2664 Form: DW_FORM_addr 2665 debug_info: 2666 - Length: 52 2667 Version: 4 2668 AbbrOffset: 0 2669 AddrSize: 8 2670 Entries: 2671 - AbbrCode: 0x00000001 2672 Values: 2673 - Value: 0x0000000000000001 2674 - AbbrCode: 0x00000002 2675 Values: 2676 - Value: 0x000000000000000D 2677 - Value: 0x0000000000001000 2678 - Value: 0x0000000000002000 2679 - AbbrCode: 0x00000003 2680 Values: 2681 - Value: 0x0000000000001000 2682 - Value: 0x0000000000002001 2683 - AbbrCode: 0x00000000 2684 Values: 2685 - AbbrCode: 0x00000000 2686 Values: 2687 )"; 2688 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2689 ASSERT_TRUE((bool)ErrOrSections); 2690 std::unique_ptr<DWARFContext> DwarfContext = 2691 DWARFContext::create(*ErrOrSections, 8); 2692 VerifyError(*DwarfContext, "error: DIE address ranges are not " 2693 "contained in its parent's ranges:"); 2694 } 2695 2696 TEST(DWARFDebugInfo, TestDwarfVerifyOverlappingFunctionRanges) { 2697 // Create a single compile unit with a two functions that have overlapping 2698 // address ranges. 2699 StringRef yamldata = R"( 2700 debug_str: 2701 - '' 2702 - /tmp/main.c 2703 - main 2704 - foo 2705 debug_abbrev: 2706 - Table: 2707 - Code: 0x00000001 2708 Tag: DW_TAG_compile_unit 2709 Children: DW_CHILDREN_yes 2710 Attributes: 2711 - Attribute: DW_AT_name 2712 Form: DW_FORM_strp 2713 - Code: 0x00000002 2714 Tag: DW_TAG_subprogram 2715 Children: DW_CHILDREN_no 2716 Attributes: 2717 - Attribute: DW_AT_name 2718 Form: DW_FORM_strp 2719 - Attribute: DW_AT_low_pc 2720 Form: DW_FORM_addr 2721 - Attribute: DW_AT_high_pc 2722 Form: DW_FORM_addr 2723 debug_info: 2724 - Length: 55 2725 Version: 4 2726 AbbrOffset: 0 2727 AddrSize: 8 2728 Entries: 2729 - AbbrCode: 0x00000001 2730 Values: 2731 - Value: 0x0000000000000001 2732 - AbbrCode: 0x00000002 2733 Values: 2734 - Value: 0x000000000000000D 2735 - Value: 0x0000000000001000 2736 - Value: 0x0000000000002000 2737 - AbbrCode: 0x00000002 2738 Values: 2739 - Value: 0x0000000000000012 2740 - Value: 0x0000000000001FFF 2741 - Value: 0x0000000000002000 2742 - AbbrCode: 0x00000000 2743 Values: 2744 )"; 2745 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2746 ASSERT_TRUE((bool)ErrOrSections); 2747 std::unique_ptr<DWARFContext> DwarfContext = 2748 DWARFContext::create(*ErrOrSections, 8); 2749 VerifyError(*DwarfContext, "error: DIEs have overlapping address ranges:"); 2750 } 2751 2752 TEST(DWARFDebugInfo, TestDwarfVerifyOverlappingLexicalBlockRanges) { 2753 // Create a single compile unit with a one function that has two lexical 2754 // blocks with overlapping address ranges. 2755 StringRef yamldata = R"( 2756 debug_str: 2757 - '' 2758 - /tmp/main.c 2759 - main 2760 debug_abbrev: 2761 - Table: 2762 - Code: 0x00000001 2763 Tag: DW_TAG_compile_unit 2764 Children: DW_CHILDREN_yes 2765 Attributes: 2766 - Attribute: DW_AT_low_pc 2767 Form: DW_FORM_addr 2768 - Attribute: DW_AT_high_pc 2769 Form: DW_FORM_addr 2770 - Attribute: DW_AT_name 2771 Form: DW_FORM_strp 2772 - Code: 0x00000002 2773 Tag: DW_TAG_subprogram 2774 Children: DW_CHILDREN_yes 2775 Attributes: 2776 - Attribute: DW_AT_name 2777 Form: DW_FORM_strp 2778 - Attribute: DW_AT_low_pc 2779 Form: DW_FORM_addr 2780 - Attribute: DW_AT_high_pc 2781 Form: DW_FORM_addr 2782 - Code: 0x00000003 2783 Tag: DW_TAG_lexical_block 2784 Children: DW_CHILDREN_no 2785 Attributes: 2786 - Attribute: DW_AT_low_pc 2787 Form: DW_FORM_addr 2788 - Attribute: DW_AT_high_pc 2789 Form: DW_FORM_addr 2790 debug_info: 2791 - Length: 85 2792 Version: 4 2793 AbbrOffset: 0 2794 AddrSize: 8 2795 Entries: 2796 - AbbrCode: 0x00000001 2797 Values: 2798 - Value: 0x0000000000001000 2799 - Value: 0x0000000000002000 2800 - Value: 0x0000000000000001 2801 - AbbrCode: 0x00000002 2802 Values: 2803 - Value: 0x000000000000000D 2804 - Value: 0x0000000000001000 2805 - Value: 0x0000000000002000 2806 - AbbrCode: 0x00000003 2807 Values: 2808 - Value: 0x0000000000001100 2809 - Value: 0x0000000000001300 2810 - AbbrCode: 0x00000003 2811 Values: 2812 - Value: 0x00000000000012FF 2813 - Value: 0x0000000000001300 2814 - AbbrCode: 0x00000000 2815 Values: 2816 - AbbrCode: 0x00000000 2817 Values: 2818 )"; 2819 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2820 ASSERT_TRUE((bool)ErrOrSections); 2821 std::unique_ptr<DWARFContext> DwarfContext = 2822 DWARFContext::create(*ErrOrSections, 8); 2823 VerifyError(*DwarfContext, "error: DIEs have overlapping address ranges:"); 2824 } 2825 2826 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidDIERange) { 2827 // Create a single compile unit with a single function that has an invalid 2828 // address range where the high PC is smaller than the low PC. 2829 StringRef yamldata = R"( 2830 debug_str: 2831 - '' 2832 - /tmp/main.c 2833 - main 2834 debug_abbrev: 2835 - Table: 2836 - Code: 0x00000001 2837 Tag: DW_TAG_compile_unit 2838 Children: DW_CHILDREN_yes 2839 Attributes: 2840 - Attribute: DW_AT_name 2841 Form: DW_FORM_strp 2842 - Code: 0x00000002 2843 Tag: DW_TAG_subprogram 2844 Children: DW_CHILDREN_no 2845 Attributes: 2846 - Attribute: DW_AT_name 2847 Form: DW_FORM_strp 2848 - Attribute: DW_AT_low_pc 2849 Form: DW_FORM_addr 2850 - Attribute: DW_AT_high_pc 2851 Form: DW_FORM_addr 2852 debug_info: 2853 - Length: 34 2854 Version: 4 2855 AbbrOffset: 0 2856 AddrSize: 8 2857 Entries: 2858 - AbbrCode: 0x00000001 2859 Values: 2860 - Value: 0x0000000000000001 2861 - AbbrCode: 0x00000002 2862 Values: 2863 - Value: 0x000000000000000D 2864 - Value: 0x0000000000001000 2865 - Value: 0x0000000000000900 2866 - AbbrCode: 0x00000000 2867 Values: 2868 )"; 2869 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2870 ASSERT_TRUE((bool)ErrOrSections); 2871 std::unique_ptr<DWARFContext> DwarfContext = 2872 DWARFContext::create(*ErrOrSections, 8); 2873 VerifyError(*DwarfContext, "error: Invalid address range"); 2874 } 2875 2876 TEST(DWARFDebugInfo, TestDwarfVerifyElidedDoesntFail) { 2877 // Create a single compile unit with two functions: one that has a valid range 2878 // and one whose low and high PC are the same. When the low and high PC are 2879 // the same, this indicates the function was dead code stripped. We want to 2880 // ensure that verification succeeds. 2881 StringRef yamldata = R"( 2882 debug_str: 2883 - '' 2884 - /tmp/main.c 2885 - main 2886 - elided 2887 debug_abbrev: 2888 - Table: 2889 - Code: 0x00000001 2890 Tag: DW_TAG_compile_unit 2891 Children: DW_CHILDREN_yes 2892 Attributes: 2893 - Attribute: DW_AT_low_pc 2894 Form: DW_FORM_addr 2895 - Attribute: DW_AT_high_pc 2896 Form: DW_FORM_addr 2897 - Attribute: DW_AT_name 2898 Form: DW_FORM_strp 2899 - Code: 0x00000002 2900 Tag: DW_TAG_subprogram 2901 Children: DW_CHILDREN_no 2902 Attributes: 2903 - Attribute: DW_AT_name 2904 Form: DW_FORM_strp 2905 - Attribute: DW_AT_low_pc 2906 Form: DW_FORM_addr 2907 - Attribute: DW_AT_high_pc 2908 Form: DW_FORM_addr 2909 debug_info: 2910 - Length: 71 2911 Version: 4 2912 AbbrOffset: 0 2913 AddrSize: 8 2914 Entries: 2915 - AbbrCode: 0x00000001 2916 Values: 2917 - Value: 0x0000000000001000 2918 - Value: 0x0000000000002000 2919 - Value: 0x0000000000000001 2920 - AbbrCode: 0x00000002 2921 Values: 2922 - Value: 0x000000000000000D 2923 - Value: 0x0000000000001000 2924 - Value: 0x0000000000002000 2925 - AbbrCode: 0x00000002 2926 Values: 2927 - Value: 0x0000000000000012 2928 - Value: 0x0000000000002000 2929 - Value: 0x0000000000002000 2930 - AbbrCode: 0x00000000 2931 Values: 2932 )"; 2933 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2934 ASSERT_TRUE((bool)ErrOrSections); 2935 std::unique_ptr<DWARFContext> DwarfContext = 2936 DWARFContext::create(*ErrOrSections, 8); 2937 VerifySuccess(*DwarfContext); 2938 } 2939 2940 TEST(DWARFDebugInfo, TestDwarfVerifyNestedFunctions) { 2941 // Create a single compile unit with a nested function which is not contained 2942 // in its parent. Although LLVM doesn't generate this, it is valid accoridng 2943 // to the DWARF standard. 2944 StringRef yamldata = R"( 2945 debug_str: 2946 - '' 2947 - /tmp/main.c 2948 - main 2949 - nested 2950 debug_abbrev: 2951 - Table: 2952 - Code: 0x00000001 2953 Tag: DW_TAG_compile_unit 2954 Children: DW_CHILDREN_yes 2955 Attributes: 2956 - Attribute: DW_AT_low_pc 2957 Form: DW_FORM_addr 2958 - Attribute: DW_AT_high_pc 2959 Form: DW_FORM_addr 2960 - Attribute: DW_AT_name 2961 Form: DW_FORM_strp 2962 - Code: 0x00000002 2963 Tag: DW_TAG_subprogram 2964 Children: DW_CHILDREN_yes 2965 Attributes: 2966 - Attribute: DW_AT_name 2967 Form: DW_FORM_strp 2968 - Attribute: DW_AT_low_pc 2969 Form: DW_FORM_addr 2970 - Attribute: DW_AT_high_pc 2971 Form: DW_FORM_addr 2972 debug_info: 2973 - Length: 73 2974 Version: 4 2975 AbbrOffset: 0 2976 AddrSize: 8 2977 Entries: 2978 - AbbrCode: 0x00000001 2979 Values: 2980 - Value: 0x0000000000001000 2981 - Value: 0x0000000000002000 2982 - Value: 0x0000000000000001 2983 - AbbrCode: 0x00000002 2984 Values: 2985 - Value: 0x000000000000000D 2986 - Value: 0x0000000000001000 2987 - Value: 0x0000000000001500 2988 - AbbrCode: 0x00000002 2989 Values: 2990 - Value: 0x0000000000000012 2991 - Value: 0x0000000000001500 2992 - Value: 0x0000000000002000 2993 - AbbrCode: 0x00000000 2994 Values: 2995 - AbbrCode: 0x00000000 2996 Values: 2997 - AbbrCode: 0x00000000 2998 Values: 2999 )"; 3000 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 3001 ASSERT_TRUE((bool)ErrOrSections); 3002 std::unique_ptr<DWARFContext> DwarfContext = 3003 DWARFContext::create(*ErrOrSections, 8); 3004 VerifySuccess(*DwarfContext); 3005 } 3006 3007 TEST(DWARFDebugInfo, TestDWARFDieRangeInfoContains) { 3008 DWARFVerifier::DieRangeInfo Empty; 3009 ASSERT_TRUE(Empty.contains(Empty)); 3010 3011 DWARFVerifier::DieRangeInfo Ranges( 3012 {{0x10, 0x20}, {0x30, 0x40}, {0x40, 0x50}}); 3013 3014 ASSERT_TRUE(Ranges.contains(Empty)); 3015 ASSERT_FALSE(Ranges.contains({{{0x0f, 0x10}}})); 3016 ASSERT_FALSE(Ranges.contains({{{0x0f, 0x20}}})); 3017 ASSERT_FALSE(Ranges.contains({{{0x0f, 0x21}}})); 3018 3019 // Test ranges that start at R's start address 3020 ASSERT_TRUE(Ranges.contains({{{0x10, 0x10}}})); 3021 ASSERT_TRUE(Ranges.contains({{{0x10, 0x11}}})); 3022 ASSERT_TRUE(Ranges.contains({{{0x10, 0x20}}})); 3023 ASSERT_FALSE(Ranges.contains({{{0x10, 0x21}}})); 3024 3025 ASSERT_TRUE(Ranges.contains({{{0x11, 0x12}}})); 3026 3027 // Test ranges that start at last bytes of Range 3028 ASSERT_TRUE(Ranges.contains({{{0x1f, 0x20}}})); 3029 ASSERT_FALSE(Ranges.contains({{{0x1f, 0x21}}})); 3030 3031 // Test ranges that start after Range 3032 ASSERT_TRUE(Ranges.contains({{{0x20, 0x20}}})); 3033 ASSERT_FALSE(Ranges.contains({{{0x20, 0x21}}})); 3034 3035 ASSERT_TRUE(Ranges.contains({{{0x31, 0x32}}})); 3036 ASSERT_TRUE(Ranges.contains({{{0x3f, 0x40}}})); 3037 ASSERT_TRUE(Ranges.contains({{{0x10, 0x20}, {0x30, 0x40}}})); 3038 ASSERT_TRUE(Ranges.contains({{{0x11, 0x12}, {0x31, 0x32}}})); 3039 ASSERT_TRUE(Ranges.contains( 3040 {{{0x11, 0x12}, {0x12, 0x13}, {0x31, 0x32}, {0x32, 0x33}}})); 3041 ASSERT_FALSE(Ranges.contains({{{0x11, 0x12}, 3042 {0x12, 0x13}, 3043 {0x20, 0x21}, 3044 {0x31, 0x32}, 3045 {0x32, 0x33}}})); 3046 ASSERT_FALSE(Ranges.contains( 3047 {{{0x11, 0x12}, {0x12, 0x13}, {0x31, 0x32}, {0x32, 0x51}}})); 3048 ASSERT_TRUE(Ranges.contains({{{0x11, 0x12}, {0x30, 0x50}}})); 3049 ASSERT_FALSE(Ranges.contains({{{0x30, 0x51}}})); 3050 ASSERT_FALSE(Ranges.contains({{{0x50, 0x51}}})); 3051 } 3052 3053 namespace { 3054 3055 void AssertRangesIntersect(const DWARFAddressRange &LHS, 3056 const DWARFAddressRange &RHS) { 3057 ASSERT_TRUE(LHS.intersects(RHS)); 3058 ASSERT_TRUE(RHS.intersects(LHS)); 3059 } 3060 void AssertRangesDontIntersect(const DWARFAddressRange &LHS, 3061 const DWARFAddressRange &RHS) { 3062 ASSERT_FALSE(LHS.intersects(RHS)); 3063 ASSERT_FALSE(RHS.intersects(LHS)); 3064 } 3065 3066 void AssertRangesIntersect(const DWARFVerifier::DieRangeInfo &LHS, 3067 const DWARFAddressRangesVector &Ranges) { 3068 DWARFVerifier::DieRangeInfo RHS(Ranges); 3069 ASSERT_TRUE(LHS.intersects(RHS)); 3070 ASSERT_TRUE(RHS.intersects(LHS)); 3071 } 3072 3073 void AssertRangesDontIntersect(const DWARFVerifier::DieRangeInfo &LHS, 3074 const DWARFAddressRangesVector &Ranges) { 3075 DWARFVerifier::DieRangeInfo RHS(Ranges); 3076 ASSERT_FALSE(LHS.intersects(RHS)); 3077 ASSERT_FALSE(RHS.intersects(LHS)); 3078 } 3079 3080 } // namespace 3081 TEST(DWARFDebugInfo, TestDwarfRangesIntersect) { 3082 DWARFAddressRange R(0x10, 0x20); 3083 3084 //---------------------------------------------------------------------- 3085 // Test ranges that start before R... 3086 //---------------------------------------------------------------------- 3087 // Other range ends before start of R 3088 AssertRangesDontIntersect(R, {0x00, 0x10}); 3089 // Other range end address is start of a R 3090 AssertRangesIntersect(R, {0x00, 0x11}); 3091 // Other range end address is in R 3092 AssertRangesIntersect(R, {0x00, 0x15}); 3093 // Other range end address is at and of R 3094 AssertRangesIntersect(R, {0x00, 0x20}); 3095 // Other range end address is past end of R 3096 AssertRangesIntersect(R, {0x00, 0x40}); 3097 3098 //---------------------------------------------------------------------- 3099 // Test ranges that start at R's start address 3100 //---------------------------------------------------------------------- 3101 // Ensure empty ranges doesn't match 3102 AssertRangesDontIntersect(R, {0x10, 0x10}); 3103 // 1 byte of Range 3104 AssertRangesIntersect(R, {0x10, 0x11}); 3105 // same as Range 3106 AssertRangesIntersect(R, {0x10, 0x20}); 3107 // 1 byte past Range 3108 AssertRangesIntersect(R, {0x10, 0x21}); 3109 3110 //---------------------------------------------------------------------- 3111 // Test ranges that start inside Range 3112 //---------------------------------------------------------------------- 3113 // empty in range 3114 AssertRangesDontIntersect(R, {0x11, 0x11}); 3115 // all in Range 3116 AssertRangesIntersect(R, {0x11, 0x1f}); 3117 // ends at end of Range 3118 AssertRangesIntersect(R, {0x11, 0x20}); 3119 // ends past Range 3120 AssertRangesIntersect(R, {0x11, 0x21}); 3121 3122 //---------------------------------------------------------------------- 3123 // Test ranges that start at last bytes of Range 3124 //---------------------------------------------------------------------- 3125 // ends at end of Range 3126 AssertRangesIntersect(R, {0x1f, 0x20}); 3127 // ends past Range 3128 AssertRangesIntersect(R, {0x1f, 0x21}); 3129 3130 //---------------------------------------------------------------------- 3131 // Test ranges that start after Range 3132 //---------------------------------------------------------------------- 3133 // empty just past in Range 3134 AssertRangesDontIntersect(R, {0x20, 0x20}); 3135 // valid past Range 3136 AssertRangesDontIntersect(R, {0x20, 0x21}); 3137 } 3138 3139 TEST(DWARFDebugInfo, TestDWARFDieRangeInfoIntersects) { 3140 3141 DWARFVerifier::DieRangeInfo Ranges({{0x10, 0x20}, {0x30, 0x40}}); 3142 3143 // Test empty range 3144 AssertRangesDontIntersect(Ranges, {}); 3145 // Test range that appears before all ranges in Ranges 3146 AssertRangesDontIntersect(Ranges, {{0x00, 0x10}}); 3147 // Test range that appears between ranges in Ranges 3148 AssertRangesDontIntersect(Ranges, {{0x20, 0x30}}); 3149 // Test range that appears after ranges in Ranges 3150 AssertRangesDontIntersect(Ranges, {{0x40, 0x50}}); 3151 3152 // Test range that start before first range 3153 AssertRangesIntersect(Ranges, {{0x00, 0x11}}); 3154 // Test range that start at first range 3155 AssertRangesIntersect(Ranges, {{0x10, 0x11}}); 3156 // Test range that start in first range 3157 AssertRangesIntersect(Ranges, {{0x11, 0x12}}); 3158 // Test range that start at end of first range 3159 AssertRangesIntersect(Ranges, {{0x1f, 0x20}}); 3160 // Test range that starts at end of first range 3161 AssertRangesDontIntersect(Ranges, {{0x20, 0x21}}); 3162 // Test range that starts at end of first range 3163 AssertRangesIntersect(Ranges, {{0x20, 0x31}}); 3164 3165 // Test range that start before second range and ends before second 3166 AssertRangesDontIntersect(Ranges, {{0x2f, 0x30}}); 3167 // Test range that start before second range and ends in second 3168 AssertRangesIntersect(Ranges, {{0x2f, 0x31}}); 3169 // Test range that start at second range 3170 AssertRangesIntersect(Ranges, {{0x30, 0x31}}); 3171 // Test range that start in second range 3172 AssertRangesIntersect(Ranges, {{0x31, 0x32}}); 3173 // Test range that start at end of second range 3174 AssertRangesIntersect(Ranges, {{0x3f, 0x40}}); 3175 // Test range that starts at end of second range 3176 AssertRangesDontIntersect(Ranges, {{0x40, 0x41}}); 3177 3178 AssertRangesDontIntersect(Ranges, {{0x20, 0x21}, {0x2f, 0x30}}); 3179 AssertRangesIntersect(Ranges, {{0x20, 0x21}, {0x2f, 0x31}}); 3180 } 3181 3182 TEST(DWARFDebugInfo, TestDWARF64UnitLength) { 3183 static const char DebugInfoSecRaw[] = 3184 "\xff\xff\xff\xff" // DWARF64 mark 3185 "\x88\x77\x66\x55\x44\x33\x22\x11" // Length 3186 "\x05\x00" // Version 3187 "\x01" // DW_UT_compile 3188 "\x04" // Address size 3189 "\0\0\0\0\0\0\0\0"; // Offset Into Abbrev. Sec. 3190 StringMap<std::unique_ptr<MemoryBuffer>> Sections; 3191 Sections.insert(std::make_pair( 3192 "debug_info", MemoryBuffer::getMemBuffer(StringRef( 3193 DebugInfoSecRaw, sizeof(DebugInfoSecRaw) - 1)))); 3194 auto Context = DWARFContext::create(Sections, /* AddrSize = */ 4, 3195 /* isLittleEndian = */ true); 3196 const auto &Obj = Context->getDWARFObj(); 3197 Obj.forEachInfoSections([&](const DWARFSection &Sec) { 3198 DWARFUnitHeader Header; 3199 DWARFDataExtractor Data(Obj, Sec, /* IsLittleEndian = */ true, 3200 /* AddressSize = */ 4); 3201 uint64_t Offset = 0; 3202 EXPECT_FALSE(Header.extract(*Context, Data, &Offset, DW_SECT_INFO)); 3203 // Header.extract() returns false because there is not enough space 3204 // in the section for the declared length. Anyway, we can check that 3205 // the properties are read correctly. 3206 ASSERT_EQ(DwarfFormat::DWARF64, Header.getFormat()); 3207 ASSERT_EQ(0x1122334455667788ULL, Header.getLength()); 3208 ASSERT_EQ(5, Header.getVersion()); 3209 ASSERT_EQ(DW_UT_compile, Header.getUnitType()); 3210 ASSERT_EQ(4, Header.getAddressByteSize()); 3211 3212 // Check that the length can be correctly read in the unit class. 3213 DWARFUnitVector DummyUnitVector; 3214 DWARFSection DummySec; 3215 DWARFCompileUnit CU(*Context, Sec, Header, /* DA = */ 0, /* RS = */ 0, 3216 /* LocSection = */ 0, /* SS = */ StringRef(), 3217 /* SOS = */ DummySec, /* AOS = */ 0, 3218 /* LS = */ DummySec, /* LE = */ true, 3219 /* isDWO= */ false, DummyUnitVector); 3220 ASSERT_EQ(0x1122334455667788ULL, CU.getLength()); 3221 }); 3222 } 3223 3224 } // end anonymous namespace 3225