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 "debug_info:\n" 1371 " - Version: 4\n" 1372 " AbbrOffset: 0\n" 1373 " AddrSize: 8\n" 1374 " Entries:\n" 1375 " - AbbrCode: 0x00000001\n" 1376 " Values:\n" 1377 " - AbbrCode: 0x00000000\n" 1378 " Values:\n"; 1379 1380 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 1381 ASSERT_TRUE((bool)ErrOrSections); 1382 std::unique_ptr<DWARFContext> DwarfContext = 1383 DWARFContext::create(*ErrOrSections, 8); 1384 1385 // Verify the number of compile units is correct. 1386 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1387 EXPECT_EQ(NumCUs, 1u); 1388 DWARFCompileUnit *U = 1389 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1390 1391 // Get the compile unit DIE is valid. 1392 auto CUDie = U->getUnitDIE(false); 1393 EXPECT_TRUE(CUDie.isValid()); 1394 1395 // Verify that the CU Die that says it has children, but doesn't, actually 1396 // has begin and end iterators that are equal. We want to make sure we don't 1397 // see the Null DIEs during iteration. 1398 EXPECT_EQ(CUDie.begin(), CUDie.end()); 1399 } 1400 1401 TEST(DWARFDebugInfo, TestAttributeIterators) { 1402 Triple Triple = getNormalizedDefaultTargetTriple(); 1403 if (!isConfigurationSupported(Triple)) 1404 return; 1405 1406 // Test the DWARF APIs related to iterating across all attribute values in a 1407 // a DWARFDie. 1408 uint16_t Version = 4; 1409 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1410 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1411 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1412 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1413 const uint64_t CULowPC = 0x1000; 1414 StringRef CUPath("/tmp/main.c"); 1415 1416 // Scope to allow us to re-use the same DIE names 1417 { 1418 auto CUDie = CU.getUnitDIE(); 1419 // Encode an attribute value before an attribute with no data. 1420 CUDie.addAttribute(DW_AT_name, DW_FORM_strp, CUPath.data()); 1421 // Encode an attribute value with no data in .debug_info/types to ensure 1422 // the iteration works correctly. 1423 CUDie.addAttribute(DW_AT_declaration, DW_FORM_flag_present); 1424 // Encode an attribute value after an attribute with no data. 1425 CUDie.addAttribute(DW_AT_low_pc, DW_FORM_addr, CULowPC); 1426 } 1427 1428 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1429 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1430 EXPECT_TRUE((bool)Obj); 1431 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1432 1433 // Verify the number of compile units is correct. 1434 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1435 EXPECT_EQ(NumCUs, 1u); 1436 DWARFCompileUnit *U = 1437 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1438 1439 // Get the compile unit DIE is valid. 1440 auto CUDie = U->getUnitDIE(false); 1441 EXPECT_TRUE(CUDie.isValid()); 1442 1443 auto R = CUDie.attributes(); 1444 auto I = R.begin(); 1445 auto E = R.end(); 1446 1447 ASSERT_NE(E, I); 1448 EXPECT_EQ(I->Attr, DW_AT_name); 1449 auto ActualCUPath = I->Value.getAsCString(); 1450 EXPECT_EQ(CUPath, *ActualCUPath); 1451 1452 ASSERT_NE(E, ++I); 1453 EXPECT_EQ(I->Attr, DW_AT_declaration); 1454 EXPECT_EQ(1ull, *I->Value.getAsUnsignedConstant()); 1455 1456 ASSERT_NE(E, ++I); 1457 EXPECT_EQ(I->Attr, DW_AT_low_pc); 1458 EXPECT_EQ(CULowPC, *I->Value.getAsAddress()); 1459 1460 EXPECT_EQ(E, ++I); 1461 } 1462 1463 TEST(DWARFDebugInfo, TestFindRecurse) { 1464 Triple Triple = getNormalizedDefaultTargetTriple(); 1465 if (!isConfigurationSupported(Triple)) 1466 return; 1467 1468 uint16_t Version = 4; 1469 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1470 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1471 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1472 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1473 1474 StringRef SpecDieName = "spec"; 1475 StringRef SpecLinkageName = "spec_linkage"; 1476 StringRef AbsDieName = "abs"; 1477 // Scope to allow us to re-use the same DIE names 1478 { 1479 auto CUDie = CU.getUnitDIE(); 1480 auto FuncSpecDie = CUDie.addChild(DW_TAG_subprogram); 1481 auto FuncAbsDie = CUDie.addChild(DW_TAG_subprogram); 1482 // Put the linkage name in a second abstract origin DIE to ensure we 1483 // recurse through more than just one DIE when looking for attributes. 1484 auto FuncAbsDie2 = CUDie.addChild(DW_TAG_subprogram); 1485 auto FuncDie = CUDie.addChild(DW_TAG_subprogram); 1486 auto VarAbsDie = CUDie.addChild(DW_TAG_variable); 1487 auto VarDie = CUDie.addChild(DW_TAG_variable); 1488 FuncSpecDie.addAttribute(DW_AT_name, DW_FORM_strp, SpecDieName); 1489 FuncAbsDie2.addAttribute(DW_AT_linkage_name, DW_FORM_strp, SpecLinkageName); 1490 FuncAbsDie.addAttribute(DW_AT_specification, DW_FORM_ref4, FuncSpecDie); 1491 FuncAbsDie.addAttribute(DW_AT_abstract_origin, DW_FORM_ref4, FuncAbsDie2); 1492 FuncDie.addAttribute(DW_AT_abstract_origin, DW_FORM_ref4, FuncAbsDie); 1493 VarAbsDie.addAttribute(DW_AT_name, DW_FORM_strp, AbsDieName); 1494 VarDie.addAttribute(DW_AT_abstract_origin, DW_FORM_ref4, VarAbsDie); 1495 } 1496 1497 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1498 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1499 EXPECT_TRUE((bool)Obj); 1500 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1501 1502 // Verify the number of compile units is correct. 1503 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1504 EXPECT_EQ(NumCUs, 1u); 1505 DWARFCompileUnit *U = 1506 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1507 1508 // Get the compile unit DIE is valid. 1509 auto CUDie = U->getUnitDIE(false); 1510 EXPECT_TRUE(CUDie.isValid()); 1511 1512 auto FuncSpecDie = CUDie.getFirstChild(); 1513 auto FuncAbsDie = FuncSpecDie.getSibling(); 1514 auto FuncAbsDie2 = FuncAbsDie.getSibling(); 1515 auto FuncDie = FuncAbsDie2.getSibling(); 1516 auto VarAbsDie = FuncDie.getSibling(); 1517 auto VarDie = VarAbsDie.getSibling(); 1518 1519 // Make sure we can't extract the name from the specification die when using 1520 // DWARFDie::find() since it won't check the DW_AT_specification DIE. 1521 EXPECT_FALSE(FuncDie.find(DW_AT_name)); 1522 1523 // Make sure we can extract the name from the specification die when using 1524 // DWARFDie::findRecursively() since it should recurse through the 1525 // DW_AT_specification DIE. 1526 auto NameOpt = FuncDie.findRecursively(DW_AT_name); 1527 EXPECT_TRUE(NameOpt); 1528 // Test the dwarf::toString() helper function. 1529 auto StringOpt = toString(NameOpt); 1530 EXPECT_TRUE(StringOpt); 1531 EXPECT_EQ(SpecDieName, StringOpt.getValueOr(nullptr)); 1532 // Test the dwarf::toString() helper function with a default value specified. 1533 EXPECT_EQ(SpecDieName, toString(NameOpt, nullptr)); 1534 1535 auto LinkageNameOpt = FuncDie.findRecursively(DW_AT_linkage_name); 1536 EXPECT_EQ(SpecLinkageName, toString(LinkageNameOpt).getValueOr(nullptr)); 1537 1538 // Make sure we can't extract the name from the abstract origin die when using 1539 // DWARFDie::find() since it won't check the DW_AT_abstract_origin DIE. 1540 EXPECT_FALSE(VarDie.find(DW_AT_name)); 1541 1542 // Make sure we can extract the name from the abstract origin die when using 1543 // DWARFDie::findRecursively() since it should recurse through the 1544 // DW_AT_abstract_origin DIE. 1545 NameOpt = VarDie.findRecursively(DW_AT_name); 1546 EXPECT_TRUE(NameOpt); 1547 // Test the dwarf::toString() helper function. 1548 StringOpt = toString(NameOpt); 1549 EXPECT_TRUE(StringOpt); 1550 EXPECT_EQ(AbsDieName, StringOpt.getValueOr(nullptr)); 1551 } 1552 1553 TEST(DWARFDebugInfo, TestDwarfToFunctions) { 1554 // Test all of the dwarf::toXXX functions that take a 1555 // Optional<DWARFFormValue> and extract the values from it. 1556 uint64_t InvalidU64 = 0xBADBADBADBADBADB; 1557 int64_t InvalidS64 = 0xBADBADBADBADBADB; 1558 1559 // First test that we don't get valid values back when using an optional with 1560 // no value. 1561 Optional<DWARFFormValue> FormValOpt1 = DWARFFormValue(); 1562 EXPECT_FALSE(toString(FormValOpt1).hasValue()); 1563 EXPECT_FALSE(toUnsigned(FormValOpt1).hasValue()); 1564 EXPECT_FALSE(toReference(FormValOpt1).hasValue()); 1565 EXPECT_FALSE(toSigned(FormValOpt1).hasValue()); 1566 EXPECT_FALSE(toAddress(FormValOpt1).hasValue()); 1567 EXPECT_FALSE(toSectionOffset(FormValOpt1).hasValue()); 1568 EXPECT_FALSE(toBlock(FormValOpt1).hasValue()); 1569 EXPECT_EQ(nullptr, toString(FormValOpt1, nullptr)); 1570 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt1, InvalidU64)); 1571 EXPECT_EQ(InvalidU64, toReference(FormValOpt1, InvalidU64)); 1572 EXPECT_EQ(InvalidU64, toAddress(FormValOpt1, InvalidU64)); 1573 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt1, InvalidU64)); 1574 EXPECT_EQ(InvalidS64, toSigned(FormValOpt1, InvalidS64)); 1575 1576 // Test successful and unsuccessful address decoding. 1577 uint64_t Address = 0x100000000ULL; 1578 Optional<DWARFFormValue> FormValOpt2 = 1579 DWARFFormValue::createFromUValue(DW_FORM_addr, Address); 1580 1581 EXPECT_FALSE(toString(FormValOpt2).hasValue()); 1582 EXPECT_FALSE(toUnsigned(FormValOpt2).hasValue()); 1583 EXPECT_FALSE(toReference(FormValOpt2).hasValue()); 1584 EXPECT_FALSE(toSigned(FormValOpt2).hasValue()); 1585 EXPECT_TRUE(toAddress(FormValOpt2).hasValue()); 1586 EXPECT_FALSE(toSectionOffset(FormValOpt2).hasValue()); 1587 EXPECT_FALSE(toBlock(FormValOpt2).hasValue()); 1588 EXPECT_EQ(nullptr, toString(FormValOpt2, nullptr)); 1589 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt2, InvalidU64)); 1590 EXPECT_EQ(InvalidU64, toReference(FormValOpt2, InvalidU64)); 1591 EXPECT_EQ(Address, toAddress(FormValOpt2, InvalidU64)); 1592 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt2, InvalidU64)); 1593 EXPECT_EQ(InvalidS64, toSigned(FormValOpt2, InvalidU64)); 1594 1595 // Test successful and unsuccessful unsigned constant decoding. 1596 uint64_t UData8 = 0x1020304050607080ULL; 1597 Optional<DWARFFormValue> FormValOpt3 = 1598 DWARFFormValue::createFromUValue(DW_FORM_udata, UData8); 1599 1600 EXPECT_FALSE(toString(FormValOpt3).hasValue()); 1601 EXPECT_TRUE(toUnsigned(FormValOpt3).hasValue()); 1602 EXPECT_FALSE(toReference(FormValOpt3).hasValue()); 1603 EXPECT_TRUE(toSigned(FormValOpt3).hasValue()); 1604 EXPECT_FALSE(toAddress(FormValOpt3).hasValue()); 1605 EXPECT_FALSE(toSectionOffset(FormValOpt3).hasValue()); 1606 EXPECT_FALSE(toBlock(FormValOpt3).hasValue()); 1607 EXPECT_EQ(nullptr, toString(FormValOpt3, nullptr)); 1608 EXPECT_EQ(UData8, toUnsigned(FormValOpt3, InvalidU64)); 1609 EXPECT_EQ(InvalidU64, toReference(FormValOpt3, InvalidU64)); 1610 EXPECT_EQ(InvalidU64, toAddress(FormValOpt3, InvalidU64)); 1611 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt3, InvalidU64)); 1612 EXPECT_EQ((int64_t)UData8, toSigned(FormValOpt3, InvalidU64)); 1613 1614 // Test successful and unsuccessful reference decoding. 1615 uint32_t RefData = 0x11223344U; 1616 Optional<DWARFFormValue> FormValOpt4 = 1617 DWARFFormValue::createFromUValue(DW_FORM_ref_addr, RefData); 1618 1619 EXPECT_FALSE(toString(FormValOpt4).hasValue()); 1620 EXPECT_FALSE(toUnsigned(FormValOpt4).hasValue()); 1621 EXPECT_TRUE(toReference(FormValOpt4).hasValue()); 1622 EXPECT_FALSE(toSigned(FormValOpt4).hasValue()); 1623 EXPECT_FALSE(toAddress(FormValOpt4).hasValue()); 1624 EXPECT_FALSE(toSectionOffset(FormValOpt4).hasValue()); 1625 EXPECT_FALSE(toBlock(FormValOpt4).hasValue()); 1626 EXPECT_EQ(nullptr, toString(FormValOpt4, nullptr)); 1627 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt4, InvalidU64)); 1628 EXPECT_EQ(RefData, toReference(FormValOpt4, InvalidU64)); 1629 EXPECT_EQ(InvalidU64, toAddress(FormValOpt4, InvalidU64)); 1630 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt4, InvalidU64)); 1631 EXPECT_EQ(InvalidS64, toSigned(FormValOpt4, InvalidU64)); 1632 1633 // Test successful and unsuccessful signed constant decoding. 1634 int64_t SData8 = 0x1020304050607080ULL; 1635 Optional<DWARFFormValue> FormValOpt5 = 1636 DWARFFormValue::createFromSValue(DW_FORM_udata, SData8); 1637 1638 EXPECT_FALSE(toString(FormValOpt5).hasValue()); 1639 EXPECT_TRUE(toUnsigned(FormValOpt5).hasValue()); 1640 EXPECT_FALSE(toReference(FormValOpt5).hasValue()); 1641 EXPECT_TRUE(toSigned(FormValOpt5).hasValue()); 1642 EXPECT_FALSE(toAddress(FormValOpt5).hasValue()); 1643 EXPECT_FALSE(toSectionOffset(FormValOpt5).hasValue()); 1644 EXPECT_FALSE(toBlock(FormValOpt5).hasValue()); 1645 EXPECT_EQ(nullptr, toString(FormValOpt5, nullptr)); 1646 EXPECT_EQ((uint64_t)SData8, toUnsigned(FormValOpt5, InvalidU64)); 1647 EXPECT_EQ(InvalidU64, toReference(FormValOpt5, InvalidU64)); 1648 EXPECT_EQ(InvalidU64, toAddress(FormValOpt5, InvalidU64)); 1649 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt5, InvalidU64)); 1650 EXPECT_EQ(SData8, toSigned(FormValOpt5, InvalidU64)); 1651 1652 // Test successful and unsuccessful block decoding. 1653 uint8_t Data[] = { 2, 3, 4 }; 1654 ArrayRef<uint8_t> Array(Data); 1655 Optional<DWARFFormValue> FormValOpt6 = 1656 DWARFFormValue::createFromBlockValue(DW_FORM_block1, Array); 1657 1658 EXPECT_FALSE(toString(FormValOpt6).hasValue()); 1659 EXPECT_FALSE(toUnsigned(FormValOpt6).hasValue()); 1660 EXPECT_FALSE(toReference(FormValOpt6).hasValue()); 1661 EXPECT_FALSE(toSigned(FormValOpt6).hasValue()); 1662 EXPECT_FALSE(toAddress(FormValOpt6).hasValue()); 1663 EXPECT_FALSE(toSectionOffset(FormValOpt6).hasValue()); 1664 auto BlockOpt = toBlock(FormValOpt6); 1665 EXPECT_TRUE(BlockOpt.hasValue()); 1666 EXPECT_EQ(*BlockOpt, Array); 1667 EXPECT_EQ(nullptr, toString(FormValOpt6, nullptr)); 1668 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt6, InvalidU64)); 1669 EXPECT_EQ(InvalidU64, toReference(FormValOpt6, InvalidU64)); 1670 EXPECT_EQ(InvalidU64, toAddress(FormValOpt6, InvalidU64)); 1671 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt6, InvalidU64)); 1672 EXPECT_EQ(InvalidS64, toSigned(FormValOpt6, InvalidU64)); 1673 1674 // Test 1675 } 1676 1677 TEST(DWARFDebugInfo, TestFindAttrs) { 1678 Triple Triple = getNormalizedDefaultTargetTriple(); 1679 if (!isConfigurationSupported(Triple)) 1680 return; 1681 1682 // Test the DWARFDie::find() and DWARFDie::findRecursively() that take an 1683 // ArrayRef<dwarf::Attribute> value to make sure they work correctly. 1684 uint16_t Version = 4; 1685 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1686 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1687 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1688 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1689 1690 StringRef DieMangled("_Z3fooi"); 1691 // Scope to allow us to re-use the same DIE names 1692 { 1693 auto CUDie = CU.getUnitDIE(); 1694 auto FuncSpecDie = CUDie.addChild(DW_TAG_subprogram); 1695 auto FuncDie = CUDie.addChild(DW_TAG_subprogram); 1696 FuncSpecDie.addAttribute(DW_AT_MIPS_linkage_name, DW_FORM_strp, DieMangled); 1697 FuncDie.addAttribute(DW_AT_specification, DW_FORM_ref4, FuncSpecDie); 1698 } 1699 1700 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1701 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1702 EXPECT_TRUE((bool)Obj); 1703 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1704 1705 // Verify the number of compile units is correct. 1706 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1707 EXPECT_EQ(NumCUs, 1u); 1708 DWARFCompileUnit *U = 1709 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1710 1711 // Get the compile unit DIE is valid. 1712 auto CUDie = U->getUnitDIE(false); 1713 EXPECT_TRUE(CUDie.isValid()); 1714 1715 auto FuncSpecDie = CUDie.getFirstChild(); 1716 auto FuncDie = FuncSpecDie.getSibling(); 1717 1718 // Make sure that passing in an empty attribute list behave correctly. 1719 EXPECT_FALSE(FuncDie.find(ArrayRef<dwarf::Attribute>()).hasValue()); 1720 1721 // Make sure that passing in a list of attribute that are not contained 1722 // in the DIE returns nothing. 1723 EXPECT_FALSE(FuncDie.find({DW_AT_low_pc, DW_AT_entry_pc}).hasValue()); 1724 1725 const dwarf::Attribute Attrs[] = {DW_AT_linkage_name, 1726 DW_AT_MIPS_linkage_name}; 1727 1728 // Make sure we can't extract the linkage name attributes when using 1729 // DWARFDie::find() since it won't check the DW_AT_specification DIE. 1730 EXPECT_FALSE(FuncDie.find(Attrs).hasValue()); 1731 1732 // Make sure we can extract the name from the specification die when using 1733 // DWARFDie::findRecursively() since it should recurse through the 1734 // DW_AT_specification DIE. 1735 auto NameOpt = FuncDie.findRecursively(Attrs); 1736 EXPECT_TRUE(NameOpt.hasValue()); 1737 EXPECT_EQ(DieMangled, toString(NameOpt, "")); 1738 } 1739 1740 TEST(DWARFDebugInfo, TestImplicitConstAbbrevs) { 1741 Triple Triple = getNormalizedDefaultTargetTriple(); 1742 if (!isConfigurationSupported(Triple)) 1743 return; 1744 1745 uint16_t Version = 5; 1746 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1747 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1748 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1749 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1750 dwarfgen::DIE CUDie = CU.getUnitDIE(); 1751 const dwarf::Attribute Attr = DW_AT_lo_user; 1752 const int64_t Val1 = 42; 1753 const int64_t Val2 = 43; 1754 1755 auto FirstVal1DIE = CUDie.addChild(DW_TAG_class_type); 1756 FirstVal1DIE.addAttribute(Attr, DW_FORM_implicit_const, Val1); 1757 1758 auto SecondVal1DIE = CUDie.addChild(DW_TAG_class_type); 1759 SecondVal1DIE.addAttribute(Attr, DW_FORM_implicit_const, Val1); 1760 1761 auto Val2DIE = CUDie.addChild(DW_TAG_class_type); 1762 Val2DIE.addAttribute(Attr, DW_FORM_implicit_const, Val2); 1763 1764 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1765 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1766 EXPECT_TRUE((bool)Obj); 1767 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1768 DWARFCompileUnit *U = 1769 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1770 EXPECT_TRUE((bool)U); 1771 1772 const auto *Abbrevs = U->getAbbreviations(); 1773 EXPECT_TRUE((bool)Abbrevs); 1774 1775 // Let's find implicit_const abbrevs and verify, 1776 // that there are exactly two of them and both of them 1777 // can be dumped correctly. 1778 typedef decltype(Abbrevs->begin()) AbbrevIt; 1779 AbbrevIt Val1Abbrev = Abbrevs->end(); 1780 AbbrevIt Val2Abbrev = Abbrevs->end(); 1781 for(auto it = Abbrevs->begin(); it != Abbrevs->end(); ++it) { 1782 if (it->getNumAttributes() == 0) 1783 continue; // root abbrev for DW_TAG_compile_unit 1784 1785 auto A = it->getAttrByIndex(0); 1786 EXPECT_EQ(A, Attr); 1787 1788 auto FormValue = it->getAttributeValue(/* offset */ 0, A, *U); 1789 EXPECT_TRUE((bool)FormValue); 1790 EXPECT_EQ(FormValue->getForm(), dwarf::DW_FORM_implicit_const); 1791 1792 const auto V = FormValue->getAsSignedConstant(); 1793 EXPECT_TRUE((bool)V); 1794 1795 auto VerifyAbbrevDump = [&V](AbbrevIt it) { 1796 std::string S; 1797 llvm::raw_string_ostream OS(S); 1798 it->dump(OS); 1799 auto FormPos = OS.str().find("DW_FORM_implicit_const"); 1800 EXPECT_NE(FormPos, std::string::npos); 1801 auto ValPos = S.find_first_of("-0123456789", FormPos); 1802 EXPECT_NE(ValPos, std::string::npos); 1803 int64_t Val = std::atoll(S.substr(ValPos).c_str()); 1804 EXPECT_EQ(Val, *V); 1805 }; 1806 1807 switch(*V) { 1808 case Val1: 1809 EXPECT_EQ(Val1Abbrev, Abbrevs->end()); 1810 Val1Abbrev = it; 1811 VerifyAbbrevDump(it); 1812 break; 1813 case Val2: 1814 EXPECT_EQ(Val2Abbrev, Abbrevs->end()); 1815 Val2Abbrev = it; 1816 VerifyAbbrevDump(it); 1817 break; 1818 default: 1819 FAIL() << "Unexpected attribute value: " << *V; 1820 } 1821 } 1822 1823 // Now let's make sure that two Val1-DIEs refer to the same abbrev, 1824 // and Val2-DIE refers to another one. 1825 auto DieDG = U->getUnitDIE(false); 1826 auto it = DieDG.begin(); 1827 std::multimap<int64_t, decltype(it->getAbbreviationDeclarationPtr())> DIEs; 1828 const DWARFAbbreviationDeclaration *AbbrevPtrVal1 = nullptr; 1829 const DWARFAbbreviationDeclaration *AbbrevPtrVal2 = nullptr; 1830 for (; it != DieDG.end(); ++it) { 1831 const auto *AbbrevPtr = it->getAbbreviationDeclarationPtr(); 1832 EXPECT_TRUE((bool)AbbrevPtr); 1833 auto FormValue = it->find(Attr); 1834 EXPECT_TRUE((bool)FormValue); 1835 const auto V = FormValue->getAsSignedConstant(); 1836 EXPECT_TRUE((bool)V); 1837 switch(*V) { 1838 case Val1: 1839 AbbrevPtrVal1 = AbbrevPtr; 1840 break; 1841 case Val2: 1842 AbbrevPtrVal2 = AbbrevPtr; 1843 break; 1844 default: 1845 FAIL() << "Unexpected attribute value: " << *V; 1846 } 1847 DIEs.insert(std::make_pair(*V, AbbrevPtr)); 1848 } 1849 EXPECT_EQ(DIEs.count(Val1), 2u); 1850 EXPECT_EQ(DIEs.count(Val2), 1u); 1851 auto Val1Range = DIEs.equal_range(Val1); 1852 for (auto it = Val1Range.first; it != Val1Range.second; ++it) 1853 EXPECT_EQ(it->second, AbbrevPtrVal1); 1854 EXPECT_EQ(DIEs.find(Val2)->second, AbbrevPtrVal2); 1855 } 1856 1857 void VerifyWarning(DWARFContext &DwarfContext, StringRef Error) { 1858 SmallString<1024> Str; 1859 raw_svector_ostream Strm(Str); 1860 EXPECT_TRUE(DwarfContext.verify(Strm)); 1861 EXPECT_TRUE(Str.str().contains(Error)); 1862 } 1863 1864 void VerifyError(DWARFContext &DwarfContext, StringRef Error) { 1865 SmallString<1024> Str; 1866 raw_svector_ostream Strm(Str); 1867 EXPECT_FALSE(DwarfContext.verify(Strm)); 1868 EXPECT_TRUE(Str.str().contains(Error)); 1869 } 1870 1871 void VerifySuccess(DWARFContext &DwarfContext) { 1872 SmallString<1024> Str; 1873 raw_svector_ostream Strm(Str); 1874 EXPECT_TRUE(DwarfContext.verify(Strm)); 1875 } 1876 1877 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidCURef) { 1878 // Create a single compile unit with a single function that has a DW_AT_type 1879 // that is CU relative. The CU offset is not valid because it is larger than 1880 // the compile unit itself. 1881 1882 const char *yamldata = R"( 1883 debug_str: 1884 - '' 1885 - /tmp/main.c 1886 - main 1887 debug_abbrev: 1888 - Table: 1889 - Code: 0x00000001 1890 Tag: DW_TAG_compile_unit 1891 Children: DW_CHILDREN_yes 1892 Attributes: 1893 - Attribute: DW_AT_name 1894 Form: DW_FORM_strp 1895 - Code: 0x00000002 1896 Tag: DW_TAG_subprogram 1897 Children: DW_CHILDREN_no 1898 Attributes: 1899 - Attribute: DW_AT_name 1900 Form: DW_FORM_strp 1901 - Attribute: DW_AT_type 1902 Form: DW_FORM_ref4 1903 debug_info: 1904 - Length: 22 1905 Version: 4 1906 AbbrOffset: 0 1907 AddrSize: 8 1908 Entries: 1909 - AbbrCode: 0x00000001 1910 Values: 1911 - Value: 0x0000000000000001 1912 - AbbrCode: 0x00000002 1913 Values: 1914 - Value: 0x000000000000000D 1915 - Value: 0x0000000000001234 1916 - AbbrCode: 0x00000000 1917 Values: 1918 )"; 1919 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 1920 ASSERT_TRUE((bool)ErrOrSections); 1921 std::unique_ptr<DWARFContext> DwarfContext = 1922 DWARFContext::create(*ErrOrSections, 8); 1923 VerifyError(*DwarfContext, "error: DW_FORM_ref4 CU offset 0x00001234 is " 1924 "invalid (must be less than CU size of " 1925 "0x0000001a):"); 1926 } 1927 1928 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidRefAddr) { 1929 // Create a single compile unit with a single function that has an invalid 1930 // DW_AT_type with an invalid .debug_info offset in its DW_FORM_ref_addr. 1931 const char *yamldata = R"( 1932 debug_str: 1933 - '' 1934 - /tmp/main.c 1935 - main 1936 debug_abbrev: 1937 - Table: 1938 - Code: 0x00000001 1939 Tag: DW_TAG_compile_unit 1940 Children: DW_CHILDREN_yes 1941 Attributes: 1942 - Attribute: DW_AT_name 1943 Form: DW_FORM_strp 1944 - Code: 0x00000002 1945 Tag: DW_TAG_subprogram 1946 Children: DW_CHILDREN_no 1947 Attributes: 1948 - Attribute: DW_AT_name 1949 Form: DW_FORM_strp 1950 - Attribute: DW_AT_type 1951 Form: DW_FORM_ref_addr 1952 debug_info: 1953 - Length: 22 1954 Version: 4 1955 AbbrOffset: 0 1956 AddrSize: 8 1957 Entries: 1958 - AbbrCode: 0x00000001 1959 Values: 1960 - Value: 0x0000000000000001 1961 - AbbrCode: 0x00000002 1962 Values: 1963 - Value: 0x000000000000000D 1964 - Value: 0x0000000000001234 1965 - AbbrCode: 0x00000000 1966 Values: 1967 )"; 1968 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 1969 ASSERT_TRUE((bool)ErrOrSections); 1970 std::unique_ptr<DWARFContext> DwarfContext = 1971 DWARFContext::create(*ErrOrSections, 8); 1972 VerifyError(*DwarfContext, 1973 "error: DW_FORM_ref_addr offset beyond .debug_info bounds:"); 1974 } 1975 1976 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidRanges) { 1977 // Create a single compile unit with a DW_AT_ranges whose section offset 1978 // isn't valid. 1979 const char *yamldata = R"( 1980 debug_str: 1981 - '' 1982 - /tmp/main.c 1983 debug_abbrev: 1984 - Table: 1985 - Code: 0x00000001 1986 Tag: DW_TAG_compile_unit 1987 Children: DW_CHILDREN_no 1988 Attributes: 1989 - Attribute: DW_AT_name 1990 Form: DW_FORM_strp 1991 - Attribute: DW_AT_ranges 1992 Form: DW_FORM_sec_offset 1993 debug_info: 1994 - Length: 16 1995 Version: 4 1996 AbbrOffset: 0 1997 AddrSize: 8 1998 Entries: 1999 - AbbrCode: 0x00000001 2000 Values: 2001 - Value: 0x0000000000000001 2002 - Value: 0x0000000000001000 2003 2004 )"; 2005 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2006 ASSERT_TRUE((bool)ErrOrSections); 2007 std::unique_ptr<DWARFContext> DwarfContext = 2008 DWARFContext::create(*ErrOrSections, 8); 2009 VerifyError( 2010 *DwarfContext, 2011 "error: DW_AT_ranges offset is beyond .debug_ranges bounds: 0x00001000"); 2012 } 2013 2014 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidRnglists) { 2015 // Create a single compile unit with a DW_AT_ranges whose section offset 2016 // isn't valid. 2017 const char *yamldata = R"( 2018 debug_str: 2019 - '' 2020 - /tmp/main.c 2021 debug_abbrev: 2022 - Table: 2023 - Code: 0x00000001 2024 Tag: DW_TAG_compile_unit 2025 Children: DW_CHILDREN_no 2026 Attributes: 2027 - Attribute: DW_AT_name 2028 Form: DW_FORM_strp 2029 - Attribute: DW_AT_ranges 2030 Form: DW_FORM_sec_offset 2031 debug_info: 2032 - Length: 17 2033 Version: 5 2034 UnitType: DW_UT_compile 2035 AbbrOffset: 0 2036 AddrSize: 8 2037 Entries: 2038 - AbbrCode: 0x00000001 2039 Values: 2040 - Value: 0x0000000000000001 2041 - Value: 0x0000000000001000 2042 2043 )"; 2044 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2045 ASSERT_TRUE((bool)ErrOrSections); 2046 std::unique_ptr<DWARFContext> DwarfContext = 2047 DWARFContext::create(*ErrOrSections, 8); 2048 VerifyError(*DwarfContext, "error: DW_AT_ranges offset is beyond " 2049 ".debug_rnglists bounds: 0x00001000"); 2050 } 2051 2052 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidStmtList) { 2053 // Create a single compile unit with a DW_AT_stmt_list whose section offset 2054 // isn't valid. 2055 const char *yamldata = R"( 2056 debug_str: 2057 - '' 2058 - /tmp/main.c 2059 debug_abbrev: 2060 - Table: 2061 - Code: 0x00000001 2062 Tag: DW_TAG_compile_unit 2063 Children: DW_CHILDREN_no 2064 Attributes: 2065 - Attribute: DW_AT_name 2066 Form: DW_FORM_strp 2067 - Attribute: DW_AT_stmt_list 2068 Form: DW_FORM_sec_offset 2069 debug_info: 2070 - Length: 16 2071 Version: 4 2072 AbbrOffset: 0 2073 AddrSize: 8 2074 Entries: 2075 - AbbrCode: 0x00000001 2076 Values: 2077 - Value: 0x0000000000000001 2078 - Value: 0x0000000000001000 2079 2080 )"; 2081 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2082 ASSERT_TRUE((bool)ErrOrSections); 2083 std::unique_ptr<DWARFContext> DwarfContext = 2084 DWARFContext::create(*ErrOrSections, 8); 2085 VerifyError( 2086 *DwarfContext, 2087 "error: DW_AT_stmt_list offset is beyond .debug_line bounds: 0x00001000"); 2088 } 2089 2090 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidStrp) { 2091 // Create a single compile unit with a single function that has an invalid 2092 // DW_FORM_strp for the DW_AT_name. 2093 const char *yamldata = R"( 2094 debug_str: 2095 - '' 2096 debug_abbrev: 2097 - Table: 2098 - Code: 0x00000001 2099 Tag: DW_TAG_compile_unit 2100 Children: DW_CHILDREN_no 2101 Attributes: 2102 - Attribute: DW_AT_name 2103 Form: DW_FORM_strp 2104 debug_info: 2105 - Length: 12 2106 Version: 4 2107 AbbrOffset: 0 2108 AddrSize: 8 2109 Entries: 2110 - AbbrCode: 0x00000001 2111 Values: 2112 - Value: 0x0000000000001234 2113 )"; 2114 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2115 ASSERT_TRUE((bool)ErrOrSections); 2116 std::unique_ptr<DWARFContext> DwarfContext = 2117 DWARFContext::create(*ErrOrSections, 8); 2118 VerifyError(*DwarfContext, 2119 "error: DW_FORM_strp offset beyond .debug_str bounds:"); 2120 } 2121 2122 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidRefAddrBetween) { 2123 // Create a single compile unit with a single function that has a DW_AT_type 2124 // with a valid .debug_info offset, but the offset is between two DIEs. 2125 const char *yamldata = R"( 2126 debug_str: 2127 - '' 2128 - /tmp/main.c 2129 - main 2130 debug_abbrev: 2131 - Table: 2132 - Code: 0x00000001 2133 Tag: DW_TAG_compile_unit 2134 Children: DW_CHILDREN_yes 2135 Attributes: 2136 - Attribute: DW_AT_name 2137 Form: DW_FORM_strp 2138 - Code: 0x00000002 2139 Tag: DW_TAG_subprogram 2140 Children: DW_CHILDREN_no 2141 Attributes: 2142 - Attribute: DW_AT_name 2143 Form: DW_FORM_strp 2144 - Attribute: DW_AT_type 2145 Form: DW_FORM_ref_addr 2146 debug_info: 2147 - Length: 22 2148 Version: 4 2149 AbbrOffset: 0 2150 AddrSize: 8 2151 Entries: 2152 - AbbrCode: 0x00000001 2153 Values: 2154 - Value: 0x0000000000000001 2155 - AbbrCode: 0x00000002 2156 Values: 2157 - Value: 0x000000000000000D 2158 - Value: 0x0000000000000011 2159 - AbbrCode: 0x00000000 2160 Values: 2161 )"; 2162 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 2163 ASSERT_TRUE((bool)ErrOrSections); 2164 std::unique_ptr<DWARFContext> DwarfContext = 2165 DWARFContext::create(*ErrOrSections, 8); 2166 VerifyError( 2167 *DwarfContext, 2168 "error: invalid DIE reference 0x00000011. Offset is in between DIEs:"); 2169 } 2170 2171 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidLineSequence) { 2172 // Create a single compile unit whose line table has a sequence in it where 2173 // the address decreases. 2174 StringRef yamldata = R"( 2175 debug_str: 2176 - '' 2177 - /tmp/main.c 2178 debug_abbrev: 2179 - Table: 2180 - Code: 0x00000001 2181 Tag: DW_TAG_compile_unit 2182 Children: DW_CHILDREN_no 2183 Attributes: 2184 - Attribute: DW_AT_name 2185 Form: DW_FORM_strp 2186 - Attribute: DW_AT_stmt_list 2187 Form: DW_FORM_sec_offset 2188 debug_info: 2189 - Length: 16 2190 Version: 4 2191 AbbrOffset: 0 2192 AddrSize: 8 2193 Entries: 2194 - AbbrCode: 0x00000001 2195 Values: 2196 - Value: 0x0000000000000001 2197 - Value: 0x0000000000000000 2198 debug_line: 2199 - Version: 2 2200 MinInstLength: 1 2201 DefaultIsStmt: 1 2202 LineBase: 251 2203 LineRange: 14 2204 OpcodeBase: 13 2205 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2206 IncludeDirs: 2207 - /tmp 2208 Files: 2209 - Name: main.c 2210 DirIdx: 1 2211 ModTime: 0 2212 Length: 0 2213 Opcodes: 2214 - Opcode: DW_LNS_extended_op 2215 ExtLen: 9 2216 SubOpcode: DW_LNE_set_address 2217 Data: 4112 2218 - Opcode: DW_LNS_advance_line 2219 SData: 9 2220 Data: 4112 2221 - Opcode: DW_LNS_copy 2222 Data: 4112 2223 - Opcode: DW_LNS_advance_pc 2224 Data: 18446744073709551600 2225 - Opcode: DW_LNS_extended_op 2226 ExtLen: 1 2227 SubOpcode: DW_LNE_end_sequence 2228 Data: 18446744073709551600 2229 )"; 2230 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2231 ASSERT_TRUE((bool)ErrOrSections); 2232 std::unique_ptr<DWARFContext> DwarfContext = 2233 DWARFContext::create(*ErrOrSections, 8); 2234 VerifyError(*DwarfContext, "error: .debug_line[0x00000000] row[1] decreases " 2235 "in address from previous row:"); 2236 } 2237 2238 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidLineFileIndex) { 2239 // Create a single compile unit whose line table has a line table row with 2240 // an invalid file index. 2241 StringRef yamldata = R"( 2242 debug_str: 2243 - '' 2244 - /tmp/main.c 2245 debug_abbrev: 2246 - Table: 2247 - Code: 0x00000001 2248 Tag: DW_TAG_compile_unit 2249 Children: DW_CHILDREN_no 2250 Attributes: 2251 - Attribute: DW_AT_name 2252 Form: DW_FORM_strp 2253 - Attribute: DW_AT_stmt_list 2254 Form: DW_FORM_sec_offset 2255 debug_info: 2256 - Length: 16 2257 Version: 4 2258 AbbrOffset: 0 2259 AddrSize: 8 2260 Entries: 2261 - AbbrCode: 0x00000001 2262 Values: 2263 - Value: 0x0000000000000001 2264 - Value: 0x0000000000000000 2265 debug_line: 2266 - Version: 2 2267 MinInstLength: 1 2268 DefaultIsStmt: 1 2269 LineBase: 251 2270 LineRange: 14 2271 OpcodeBase: 13 2272 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2273 IncludeDirs: 2274 - /tmp 2275 Files: 2276 - Name: main.c 2277 DirIdx: 1 2278 ModTime: 0 2279 Length: 0 2280 Opcodes: 2281 - Opcode: DW_LNS_extended_op 2282 ExtLen: 9 2283 SubOpcode: DW_LNE_set_address 2284 Data: 4096 2285 - Opcode: DW_LNS_advance_line 2286 SData: 9 2287 Data: 4096 2288 - Opcode: DW_LNS_copy 2289 Data: 4096 2290 - Opcode: DW_LNS_advance_pc 2291 Data: 16 2292 - Opcode: DW_LNS_set_file 2293 Data: 5 2294 - Opcode: DW_LNS_extended_op 2295 ExtLen: 1 2296 SubOpcode: DW_LNE_end_sequence 2297 Data: 5 2298 )"; 2299 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2300 ASSERT_TRUE((bool)ErrOrSections); 2301 std::unique_ptr<DWARFContext> DwarfContext = 2302 DWARFContext::create(*ErrOrSections, 8); 2303 VerifyError(*DwarfContext, "error: .debug_line[0x00000000][1] has invalid " 2304 "file index 5 (valid values are [1,1]):"); 2305 } 2306 2307 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidLineTablePorlogueDirIndex) { 2308 // Create a single compile unit whose line table has a prologue with an 2309 // invalid dir index. 2310 StringRef yamldata = R"( 2311 debug_str: 2312 - '' 2313 - /tmp/main.c 2314 debug_abbrev: 2315 - Table: 2316 - Code: 0x00000001 2317 Tag: DW_TAG_compile_unit 2318 Children: DW_CHILDREN_no 2319 Attributes: 2320 - Attribute: DW_AT_name 2321 Form: DW_FORM_strp 2322 - Attribute: DW_AT_stmt_list 2323 Form: DW_FORM_sec_offset 2324 debug_info: 2325 - Length: 16 2326 Version: 4 2327 AbbrOffset: 0 2328 AddrSize: 8 2329 Entries: 2330 - AbbrCode: 0x00000001 2331 Values: 2332 - Value: 0x0000000000000001 2333 - Value: 0x0000000000000000 2334 debug_line: 2335 - Version: 2 2336 MinInstLength: 1 2337 DefaultIsStmt: 1 2338 LineBase: 251 2339 LineRange: 14 2340 OpcodeBase: 13 2341 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2342 IncludeDirs: 2343 - /tmp 2344 Files: 2345 - Name: main.c 2346 DirIdx: 2 2347 ModTime: 0 2348 Length: 0 2349 Opcodes: 2350 - Opcode: DW_LNS_extended_op 2351 ExtLen: 9 2352 SubOpcode: DW_LNE_set_address 2353 Data: 4096 2354 - Opcode: DW_LNS_advance_line 2355 SData: 9 2356 Data: 4096 2357 - Opcode: DW_LNS_copy 2358 Data: 4096 2359 - Opcode: DW_LNS_advance_pc 2360 Data: 16 2361 - Opcode: DW_LNS_set_file 2362 Data: 1 2363 - Opcode: DW_LNS_extended_op 2364 ExtLen: 1 2365 SubOpcode: DW_LNE_end_sequence 2366 Data: 1 2367 )"; 2368 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2369 ASSERT_TRUE((bool)ErrOrSections); 2370 std::unique_ptr<DWARFContext> DwarfContext = 2371 DWARFContext::create(*ErrOrSections, 8); 2372 VerifyError(*DwarfContext, 2373 "error: .debug_line[0x00000000].prologue." 2374 "file_names[1].dir_idx contains an invalid index: 2"); 2375 } 2376 2377 TEST(DWARFDebugInfo, TestDwarfVerifyDuplicateFileWarning) { 2378 // Create a single compile unit whose line table has a prologue with an 2379 // invalid dir index. 2380 StringRef yamldata = R"( 2381 debug_str: 2382 - '' 2383 - /tmp/main.c 2384 debug_abbrev: 2385 - Table: 2386 - Code: 0x00000001 2387 Tag: DW_TAG_compile_unit 2388 Children: DW_CHILDREN_no 2389 Attributes: 2390 - Attribute: DW_AT_name 2391 Form: DW_FORM_strp 2392 - Attribute: DW_AT_stmt_list 2393 Form: DW_FORM_sec_offset 2394 debug_info: 2395 - Length: 16 2396 Version: 4 2397 AbbrOffset: 0 2398 AddrSize: 8 2399 Entries: 2400 - AbbrCode: 0x00000001 2401 Values: 2402 - Value: 0x0000000000000001 2403 - Value: 0x0000000000000000 2404 debug_line: 2405 - Version: 2 2406 MinInstLength: 1 2407 DefaultIsStmt: 1 2408 LineBase: 251 2409 LineRange: 14 2410 OpcodeBase: 13 2411 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2412 IncludeDirs: 2413 - /tmp 2414 Files: 2415 - Name: main.c 2416 DirIdx: 1 2417 ModTime: 0 2418 Length: 0 2419 - Name: main.c 2420 DirIdx: 1 2421 ModTime: 0 2422 Length: 0 2423 Opcodes: 2424 - Opcode: DW_LNS_extended_op 2425 ExtLen: 9 2426 SubOpcode: DW_LNE_set_address 2427 Data: 4096 2428 - Opcode: DW_LNS_advance_line 2429 SData: 9 2430 Data: 4096 2431 - Opcode: DW_LNS_copy 2432 Data: 4096 2433 - Opcode: DW_LNS_advance_pc 2434 Data: 16 2435 - Opcode: DW_LNS_set_file 2436 Data: 1 2437 - Opcode: DW_LNS_extended_op 2438 ExtLen: 1 2439 SubOpcode: DW_LNE_end_sequence 2440 Data: 2 2441 )"; 2442 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2443 ASSERT_TRUE((bool)ErrOrSections); 2444 std::unique_ptr<DWARFContext> DwarfContext = 2445 DWARFContext::create(*ErrOrSections, 8); 2446 VerifyWarning(*DwarfContext, 2447 "warning: .debug_line[0x00000000].prologue.file_names[2] is " 2448 "a duplicate of file_names[1]"); 2449 } 2450 2451 TEST(DWARFDebugInfo, TestDwarfVerifyCUDontShareLineTable) { 2452 // Create a two compile units where both compile units share the same 2453 // DW_AT_stmt_list value and verify we report the error correctly. 2454 StringRef yamldata = R"( 2455 debug_str: 2456 - '' 2457 - /tmp/main.c 2458 - /tmp/foo.c 2459 debug_abbrev: 2460 - Table: 2461 - Code: 0x00000001 2462 Tag: DW_TAG_compile_unit 2463 Children: DW_CHILDREN_no 2464 Attributes: 2465 - Attribute: DW_AT_name 2466 Form: DW_FORM_strp 2467 - Attribute: DW_AT_stmt_list 2468 Form: DW_FORM_sec_offset 2469 debug_info: 2470 - Length: 16 2471 Version: 4 2472 AbbrOffset: 0 2473 AddrSize: 8 2474 Entries: 2475 - AbbrCode: 0x00000001 2476 Values: 2477 - Value: 0x0000000000000001 2478 - Value: 0x0000000000000000 2479 - Length: 16 2480 Version: 4 2481 AbbrevTableID: 0 2482 AbbrOffset: 0 2483 AddrSize: 8 2484 Entries: 2485 - AbbrCode: 0x00000001 2486 Values: 2487 - Value: 0x000000000000000D 2488 - Value: 0x0000000000000000 2489 debug_line: 2490 - Version: 2 2491 MinInstLength: 1 2492 DefaultIsStmt: 1 2493 LineBase: 251 2494 LineRange: 14 2495 OpcodeBase: 13 2496 StandardOpcodeLengths: [ 0, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0, 1 ] 2497 IncludeDirs: 2498 - /tmp 2499 Files: 2500 - Name: main.c 2501 DirIdx: 1 2502 ModTime: 0 2503 Length: 0 2504 Opcodes: 2505 - Opcode: DW_LNS_extended_op 2506 ExtLen: 9 2507 SubOpcode: DW_LNE_set_address 2508 Data: 4096 2509 - Opcode: DW_LNS_advance_line 2510 SData: 9 2511 Data: 4096 2512 - Opcode: DW_LNS_copy 2513 Data: 4096 2514 - Opcode: DW_LNS_advance_pc 2515 Data: 256 2516 - Opcode: DW_LNS_extended_op 2517 ExtLen: 1 2518 SubOpcode: DW_LNE_end_sequence 2519 Data: 256 2520 )"; 2521 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2522 ASSERT_TRUE((bool)ErrOrSections); 2523 std::unique_ptr<DWARFContext> DwarfContext = 2524 DWARFContext::create(*ErrOrSections, 8); 2525 VerifyError(*DwarfContext, 2526 "error: two compile unit DIEs, 0x0000000b and " 2527 "0x0000001f, have the same DW_AT_stmt_list section " 2528 "offset:"); 2529 } 2530 2531 TEST(DWARFDebugInfo, TestErrorReporting) { 2532 Triple Triple("x86_64-pc-linux"); 2533 if (!isConfigurationSupported(Triple)) 2534 return; 2535 2536 auto ExpectedDG = dwarfgen::Generator::create(Triple, 4 /*DwarfVersion*/); 2537 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 2538 dwarfgen::Generator *DG = ExpectedDG.get().get(); 2539 AsmPrinter *AP = DG->getAsmPrinter(); 2540 MCContext *MC = DG->getMCContext(); 2541 2542 // Emit two compressed sections with broken headers. 2543 AP->OutStreamer->SwitchSection( 2544 MC->getELFSection(".zdebug_foo", 0 /*Type*/, 0 /*Flags*/)); 2545 AP->OutStreamer->emitBytes("0"); 2546 AP->OutStreamer->SwitchSection( 2547 MC->getELFSection(".zdebug_bar", 0 /*Type*/, 0 /*Flags*/)); 2548 AP->OutStreamer->emitBytes("0"); 2549 2550 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 2551 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 2552 EXPECT_TRUE((bool)Obj); 2553 2554 // DWARFContext parses whole file and finds the two errors we expect. 2555 int Errors = 0; 2556 std::unique_ptr<DWARFContext> Ctx1 = 2557 DWARFContext::create(**Obj, nullptr, "", [&](Error E) { 2558 ++Errors; 2559 consumeError(std::move(E)); 2560 }); 2561 EXPECT_TRUE(Errors == 2); 2562 } 2563 2564 TEST(DWARFDebugInfo, TestDwarfVerifyCURangesIncomplete) { 2565 // Create a single compile unit with a single function. The compile 2566 // unit has a DW_AT_ranges attribute that doesn't fully contain the 2567 // address range of the function. The verification should fail due to 2568 // the CU ranges not containing all of the address ranges of all of the 2569 // functions. 2570 StringRef yamldata = R"( 2571 debug_str: 2572 - '' 2573 - /tmp/main.c 2574 debug_abbrev: 2575 - Table: 2576 - Code: 0x00000001 2577 Tag: DW_TAG_compile_unit 2578 Children: DW_CHILDREN_yes 2579 Attributes: 2580 - Attribute: DW_AT_low_pc 2581 Form: DW_FORM_addr 2582 - Attribute: DW_AT_high_pc 2583 Form: DW_FORM_addr 2584 - Attribute: DW_AT_name 2585 Form: DW_FORM_strp 2586 - Code: 0x00000002 2587 Tag: DW_TAG_subprogram 2588 Children: DW_CHILDREN_no 2589 Attributes: 2590 - Attribute: DW_AT_low_pc 2591 Form: DW_FORM_addr 2592 - Attribute: DW_AT_high_pc 2593 Form: DW_FORM_addr 2594 debug_info: 2595 - Length: 46 2596 Version: 4 2597 AbbrOffset: 0 2598 AddrSize: 8 2599 Entries: 2600 - AbbrCode: 0x00000001 2601 Values: 2602 - Value: 0x0000000000001000 2603 - Value: 0x0000000000001500 2604 - Value: 0x0000000000000001 2605 - AbbrCode: 0x00000002 2606 Values: 2607 - Value: 0x0000000000001000 2608 - Value: 0x0000000000002000 2609 - AbbrCode: 0x00000000 2610 Values: 2611 )"; 2612 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2613 ASSERT_TRUE((bool)ErrOrSections); 2614 std::unique_ptr<DWARFContext> DwarfContext = 2615 DWARFContext::create(*ErrOrSections, 8); 2616 VerifyError(*DwarfContext, "error: DIE address ranges are not " 2617 "contained in its parent's ranges:"); 2618 } 2619 2620 TEST(DWARFDebugInfo, TestDwarfVerifyLexicalBlockRanges) { 2621 // Create a single compile unit with a single function that has a lexical 2622 // block whose address range is not contained in the function address range. 2623 StringRef yamldata = R"( 2624 debug_str: 2625 - '' 2626 - /tmp/main.c 2627 - main 2628 debug_abbrev: 2629 - Table: 2630 - Code: 0x00000001 2631 Tag: DW_TAG_compile_unit 2632 Children: DW_CHILDREN_yes 2633 Attributes: 2634 - Attribute: DW_AT_name 2635 Form: DW_FORM_strp 2636 - Code: 0x00000002 2637 Tag: DW_TAG_subprogram 2638 Children: DW_CHILDREN_yes 2639 Attributes: 2640 - Attribute: DW_AT_name 2641 Form: DW_FORM_strp 2642 - Attribute: DW_AT_low_pc 2643 Form: DW_FORM_addr 2644 - Attribute: DW_AT_high_pc 2645 Form: DW_FORM_addr 2646 - Code: 0x00000003 2647 Tag: DW_TAG_lexical_block 2648 Children: DW_CHILDREN_no 2649 Attributes: 2650 - Attribute: DW_AT_low_pc 2651 Form: DW_FORM_addr 2652 - Attribute: DW_AT_high_pc 2653 Form: DW_FORM_addr 2654 debug_info: 2655 - Length: 52 2656 Version: 4 2657 AbbrOffset: 0 2658 AddrSize: 8 2659 Entries: 2660 - AbbrCode: 0x00000001 2661 Values: 2662 - Value: 0x0000000000000001 2663 - AbbrCode: 0x00000002 2664 Values: 2665 - Value: 0x000000000000000D 2666 - Value: 0x0000000000001000 2667 - Value: 0x0000000000002000 2668 - AbbrCode: 0x00000003 2669 Values: 2670 - Value: 0x0000000000001000 2671 - Value: 0x0000000000002001 2672 - AbbrCode: 0x00000000 2673 Values: 2674 - AbbrCode: 0x00000000 2675 Values: 2676 )"; 2677 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2678 ASSERT_TRUE((bool)ErrOrSections); 2679 std::unique_ptr<DWARFContext> DwarfContext = 2680 DWARFContext::create(*ErrOrSections, 8); 2681 VerifyError(*DwarfContext, "error: DIE address ranges are not " 2682 "contained in its parent's ranges:"); 2683 } 2684 2685 TEST(DWARFDebugInfo, TestDwarfVerifyOverlappingFunctionRanges) { 2686 // Create a single compile unit with a two functions that have overlapping 2687 // address ranges. 2688 StringRef yamldata = R"( 2689 debug_str: 2690 - '' 2691 - /tmp/main.c 2692 - main 2693 - foo 2694 debug_abbrev: 2695 - Table: 2696 - Code: 0x00000001 2697 Tag: DW_TAG_compile_unit 2698 Children: DW_CHILDREN_yes 2699 Attributes: 2700 - Attribute: DW_AT_name 2701 Form: DW_FORM_strp 2702 - Code: 0x00000002 2703 Tag: DW_TAG_subprogram 2704 Children: DW_CHILDREN_no 2705 Attributes: 2706 - Attribute: DW_AT_name 2707 Form: DW_FORM_strp 2708 - Attribute: DW_AT_low_pc 2709 Form: DW_FORM_addr 2710 - Attribute: DW_AT_high_pc 2711 Form: DW_FORM_addr 2712 debug_info: 2713 - Length: 55 2714 Version: 4 2715 AbbrOffset: 0 2716 AddrSize: 8 2717 Entries: 2718 - AbbrCode: 0x00000001 2719 Values: 2720 - Value: 0x0000000000000001 2721 - AbbrCode: 0x00000002 2722 Values: 2723 - Value: 0x000000000000000D 2724 - Value: 0x0000000000001000 2725 - Value: 0x0000000000002000 2726 - AbbrCode: 0x00000002 2727 Values: 2728 - Value: 0x0000000000000012 2729 - Value: 0x0000000000001FFF 2730 - Value: 0x0000000000002000 2731 - AbbrCode: 0x00000000 2732 Values: 2733 )"; 2734 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2735 ASSERT_TRUE((bool)ErrOrSections); 2736 std::unique_ptr<DWARFContext> DwarfContext = 2737 DWARFContext::create(*ErrOrSections, 8); 2738 VerifyError(*DwarfContext, "error: DIEs have overlapping address ranges:"); 2739 } 2740 2741 TEST(DWARFDebugInfo, TestDwarfVerifyOverlappingLexicalBlockRanges) { 2742 // Create a single compile unit with a one function that has two lexical 2743 // blocks with overlapping address ranges. 2744 StringRef yamldata = R"( 2745 debug_str: 2746 - '' 2747 - /tmp/main.c 2748 - main 2749 debug_abbrev: 2750 - Table: 2751 - Code: 0x00000001 2752 Tag: DW_TAG_compile_unit 2753 Children: DW_CHILDREN_yes 2754 Attributes: 2755 - Attribute: DW_AT_low_pc 2756 Form: DW_FORM_addr 2757 - Attribute: DW_AT_high_pc 2758 Form: DW_FORM_addr 2759 - Attribute: DW_AT_name 2760 Form: DW_FORM_strp 2761 - Code: 0x00000002 2762 Tag: DW_TAG_subprogram 2763 Children: DW_CHILDREN_yes 2764 Attributes: 2765 - Attribute: DW_AT_name 2766 Form: DW_FORM_strp 2767 - Attribute: DW_AT_low_pc 2768 Form: DW_FORM_addr 2769 - Attribute: DW_AT_high_pc 2770 Form: DW_FORM_addr 2771 - Code: 0x00000003 2772 Tag: DW_TAG_lexical_block 2773 Children: DW_CHILDREN_no 2774 Attributes: 2775 - Attribute: DW_AT_low_pc 2776 Form: DW_FORM_addr 2777 - Attribute: DW_AT_high_pc 2778 Form: DW_FORM_addr 2779 debug_info: 2780 - Length: 85 2781 Version: 4 2782 AbbrOffset: 0 2783 AddrSize: 8 2784 Entries: 2785 - AbbrCode: 0x00000001 2786 Values: 2787 - Value: 0x0000000000001000 2788 - Value: 0x0000000000002000 2789 - Value: 0x0000000000000001 2790 - AbbrCode: 0x00000002 2791 Values: 2792 - Value: 0x000000000000000D 2793 - Value: 0x0000000000001000 2794 - Value: 0x0000000000002000 2795 - AbbrCode: 0x00000003 2796 Values: 2797 - Value: 0x0000000000001100 2798 - Value: 0x0000000000001300 2799 - AbbrCode: 0x00000003 2800 Values: 2801 - Value: 0x00000000000012FF 2802 - Value: 0x0000000000001300 2803 - AbbrCode: 0x00000000 2804 Values: 2805 - AbbrCode: 0x00000000 2806 Values: 2807 )"; 2808 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2809 ASSERT_TRUE((bool)ErrOrSections); 2810 std::unique_ptr<DWARFContext> DwarfContext = 2811 DWARFContext::create(*ErrOrSections, 8); 2812 VerifyError(*DwarfContext, "error: DIEs have overlapping address ranges:"); 2813 } 2814 2815 TEST(DWARFDebugInfo, TestDwarfVerifyInvalidDIERange) { 2816 // Create a single compile unit with a single function that has an invalid 2817 // address range where the high PC is smaller than the low PC. 2818 StringRef yamldata = R"( 2819 debug_str: 2820 - '' 2821 - /tmp/main.c 2822 - main 2823 debug_abbrev: 2824 - Table: 2825 - Code: 0x00000001 2826 Tag: DW_TAG_compile_unit 2827 Children: DW_CHILDREN_yes 2828 Attributes: 2829 - Attribute: DW_AT_name 2830 Form: DW_FORM_strp 2831 - Code: 0x00000002 2832 Tag: DW_TAG_subprogram 2833 Children: DW_CHILDREN_no 2834 Attributes: 2835 - Attribute: DW_AT_name 2836 Form: DW_FORM_strp 2837 - Attribute: DW_AT_low_pc 2838 Form: DW_FORM_addr 2839 - Attribute: DW_AT_high_pc 2840 Form: DW_FORM_addr 2841 debug_info: 2842 - Length: 34 2843 Version: 4 2844 AbbrOffset: 0 2845 AddrSize: 8 2846 Entries: 2847 - AbbrCode: 0x00000001 2848 Values: 2849 - Value: 0x0000000000000001 2850 - AbbrCode: 0x00000002 2851 Values: 2852 - Value: 0x000000000000000D 2853 - Value: 0x0000000000001000 2854 - Value: 0x0000000000000900 2855 - AbbrCode: 0x00000000 2856 Values: 2857 )"; 2858 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2859 ASSERT_TRUE((bool)ErrOrSections); 2860 std::unique_ptr<DWARFContext> DwarfContext = 2861 DWARFContext::create(*ErrOrSections, 8); 2862 VerifyError(*DwarfContext, "error: Invalid address range"); 2863 } 2864 2865 TEST(DWARFDebugInfo, TestDwarfVerifyElidedDoesntFail) { 2866 // Create a single compile unit with two functions: one that has a valid range 2867 // and one whose low and high PC are the same. When the low and high PC are 2868 // the same, this indicates the function was dead code stripped. We want to 2869 // ensure that verification succeeds. 2870 StringRef yamldata = R"( 2871 debug_str: 2872 - '' 2873 - /tmp/main.c 2874 - main 2875 - elided 2876 debug_abbrev: 2877 - Table: 2878 - Code: 0x00000001 2879 Tag: DW_TAG_compile_unit 2880 Children: DW_CHILDREN_yes 2881 Attributes: 2882 - Attribute: DW_AT_low_pc 2883 Form: DW_FORM_addr 2884 - Attribute: DW_AT_high_pc 2885 Form: DW_FORM_addr 2886 - Attribute: DW_AT_name 2887 Form: DW_FORM_strp 2888 - Code: 0x00000002 2889 Tag: DW_TAG_subprogram 2890 Children: DW_CHILDREN_no 2891 Attributes: 2892 - Attribute: DW_AT_name 2893 Form: DW_FORM_strp 2894 - Attribute: DW_AT_low_pc 2895 Form: DW_FORM_addr 2896 - Attribute: DW_AT_high_pc 2897 Form: DW_FORM_addr 2898 debug_info: 2899 - Length: 71 2900 Version: 4 2901 AbbrOffset: 0 2902 AddrSize: 8 2903 Entries: 2904 - AbbrCode: 0x00000001 2905 Values: 2906 - Value: 0x0000000000001000 2907 - Value: 0x0000000000002000 2908 - Value: 0x0000000000000001 2909 - AbbrCode: 0x00000002 2910 Values: 2911 - Value: 0x000000000000000D 2912 - Value: 0x0000000000001000 2913 - Value: 0x0000000000002000 2914 - AbbrCode: 0x00000002 2915 Values: 2916 - Value: 0x0000000000000012 2917 - Value: 0x0000000000002000 2918 - Value: 0x0000000000002000 2919 - AbbrCode: 0x00000000 2920 Values: 2921 )"; 2922 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2923 ASSERT_TRUE((bool)ErrOrSections); 2924 std::unique_ptr<DWARFContext> DwarfContext = 2925 DWARFContext::create(*ErrOrSections, 8); 2926 VerifySuccess(*DwarfContext); 2927 } 2928 2929 TEST(DWARFDebugInfo, TestDwarfVerifyNestedFunctions) { 2930 // Create a single compile unit with a nested function which is not contained 2931 // in its parent. Although LLVM doesn't generate this, it is valid accoridng 2932 // to the DWARF standard. 2933 StringRef yamldata = R"( 2934 debug_str: 2935 - '' 2936 - /tmp/main.c 2937 - main 2938 - nested 2939 debug_abbrev: 2940 - Table: 2941 - Code: 0x00000001 2942 Tag: DW_TAG_compile_unit 2943 Children: DW_CHILDREN_yes 2944 Attributes: 2945 - Attribute: DW_AT_low_pc 2946 Form: DW_FORM_addr 2947 - Attribute: DW_AT_high_pc 2948 Form: DW_FORM_addr 2949 - Attribute: DW_AT_name 2950 Form: DW_FORM_strp 2951 - Code: 0x00000002 2952 Tag: DW_TAG_subprogram 2953 Children: DW_CHILDREN_yes 2954 Attributes: 2955 - Attribute: DW_AT_name 2956 Form: DW_FORM_strp 2957 - Attribute: DW_AT_low_pc 2958 Form: DW_FORM_addr 2959 - Attribute: DW_AT_high_pc 2960 Form: DW_FORM_addr 2961 debug_info: 2962 - Length: 73 2963 Version: 4 2964 AbbrOffset: 0 2965 AddrSize: 8 2966 Entries: 2967 - AbbrCode: 0x00000001 2968 Values: 2969 - Value: 0x0000000000001000 2970 - Value: 0x0000000000002000 2971 - Value: 0x0000000000000001 2972 - AbbrCode: 0x00000002 2973 Values: 2974 - Value: 0x000000000000000D 2975 - Value: 0x0000000000001000 2976 - Value: 0x0000000000001500 2977 - AbbrCode: 0x00000002 2978 Values: 2979 - Value: 0x0000000000000012 2980 - Value: 0x0000000000001500 2981 - Value: 0x0000000000002000 2982 - AbbrCode: 0x00000000 2983 Values: 2984 - AbbrCode: 0x00000000 2985 Values: 2986 - AbbrCode: 0x00000000 2987 Values: 2988 )"; 2989 auto ErrOrSections = DWARFYAML::emitDebugSections(yamldata); 2990 ASSERT_TRUE((bool)ErrOrSections); 2991 std::unique_ptr<DWARFContext> DwarfContext = 2992 DWARFContext::create(*ErrOrSections, 8); 2993 VerifySuccess(*DwarfContext); 2994 } 2995 2996 TEST(DWARFDebugInfo, TestDWARFDieRangeInfoContains) { 2997 DWARFVerifier::DieRangeInfo Empty; 2998 ASSERT_TRUE(Empty.contains(Empty)); 2999 3000 DWARFVerifier::DieRangeInfo Ranges( 3001 {{0x10, 0x20}, {0x30, 0x40}, {0x40, 0x50}}); 3002 3003 ASSERT_TRUE(Ranges.contains(Empty)); 3004 ASSERT_FALSE(Ranges.contains({{{0x0f, 0x10}}})); 3005 ASSERT_FALSE(Ranges.contains({{{0x0f, 0x20}}})); 3006 ASSERT_FALSE(Ranges.contains({{{0x0f, 0x21}}})); 3007 3008 // Test ranges that start at R's start address 3009 ASSERT_TRUE(Ranges.contains({{{0x10, 0x10}}})); 3010 ASSERT_TRUE(Ranges.contains({{{0x10, 0x11}}})); 3011 ASSERT_TRUE(Ranges.contains({{{0x10, 0x20}}})); 3012 ASSERT_FALSE(Ranges.contains({{{0x10, 0x21}}})); 3013 3014 ASSERT_TRUE(Ranges.contains({{{0x11, 0x12}}})); 3015 3016 // Test ranges that start at last bytes of Range 3017 ASSERT_TRUE(Ranges.contains({{{0x1f, 0x20}}})); 3018 ASSERT_FALSE(Ranges.contains({{{0x1f, 0x21}}})); 3019 3020 // Test ranges that start after Range 3021 ASSERT_TRUE(Ranges.contains({{{0x20, 0x20}}})); 3022 ASSERT_FALSE(Ranges.contains({{{0x20, 0x21}}})); 3023 3024 ASSERT_TRUE(Ranges.contains({{{0x31, 0x32}}})); 3025 ASSERT_TRUE(Ranges.contains({{{0x3f, 0x40}}})); 3026 ASSERT_TRUE(Ranges.contains({{{0x10, 0x20}, {0x30, 0x40}}})); 3027 ASSERT_TRUE(Ranges.contains({{{0x11, 0x12}, {0x31, 0x32}}})); 3028 ASSERT_TRUE(Ranges.contains( 3029 {{{0x11, 0x12}, {0x12, 0x13}, {0x31, 0x32}, {0x32, 0x33}}})); 3030 ASSERT_FALSE(Ranges.contains({{{0x11, 0x12}, 3031 {0x12, 0x13}, 3032 {0x20, 0x21}, 3033 {0x31, 0x32}, 3034 {0x32, 0x33}}})); 3035 ASSERT_FALSE(Ranges.contains( 3036 {{{0x11, 0x12}, {0x12, 0x13}, {0x31, 0x32}, {0x32, 0x51}}})); 3037 ASSERT_TRUE(Ranges.contains({{{0x11, 0x12}, {0x30, 0x50}}})); 3038 ASSERT_FALSE(Ranges.contains({{{0x30, 0x51}}})); 3039 ASSERT_FALSE(Ranges.contains({{{0x50, 0x51}}})); 3040 } 3041 3042 namespace { 3043 3044 void AssertRangesIntersect(const DWARFAddressRange &LHS, 3045 const DWARFAddressRange &RHS) { 3046 ASSERT_TRUE(LHS.intersects(RHS)); 3047 ASSERT_TRUE(RHS.intersects(LHS)); 3048 } 3049 void AssertRangesDontIntersect(const DWARFAddressRange &LHS, 3050 const DWARFAddressRange &RHS) { 3051 ASSERT_FALSE(LHS.intersects(RHS)); 3052 ASSERT_FALSE(RHS.intersects(LHS)); 3053 } 3054 3055 void AssertRangesIntersect(const DWARFVerifier::DieRangeInfo &LHS, 3056 const DWARFAddressRangesVector &Ranges) { 3057 DWARFVerifier::DieRangeInfo RHS(Ranges); 3058 ASSERT_TRUE(LHS.intersects(RHS)); 3059 ASSERT_TRUE(RHS.intersects(LHS)); 3060 } 3061 3062 void AssertRangesDontIntersect(const DWARFVerifier::DieRangeInfo &LHS, 3063 const DWARFAddressRangesVector &Ranges) { 3064 DWARFVerifier::DieRangeInfo RHS(Ranges); 3065 ASSERT_FALSE(LHS.intersects(RHS)); 3066 ASSERT_FALSE(RHS.intersects(LHS)); 3067 } 3068 3069 } // namespace 3070 TEST(DWARFDebugInfo, TestDwarfRangesIntersect) { 3071 DWARFAddressRange R(0x10, 0x20); 3072 3073 //---------------------------------------------------------------------- 3074 // Test ranges that start before R... 3075 //---------------------------------------------------------------------- 3076 // Other range ends before start of R 3077 AssertRangesDontIntersect(R, {0x00, 0x10}); 3078 // Other range end address is start of a R 3079 AssertRangesIntersect(R, {0x00, 0x11}); 3080 // Other range end address is in R 3081 AssertRangesIntersect(R, {0x00, 0x15}); 3082 // Other range end address is at and of R 3083 AssertRangesIntersect(R, {0x00, 0x20}); 3084 // Other range end address is past end of R 3085 AssertRangesIntersect(R, {0x00, 0x40}); 3086 3087 //---------------------------------------------------------------------- 3088 // Test ranges that start at R's start address 3089 //---------------------------------------------------------------------- 3090 // Ensure empty ranges doesn't match 3091 AssertRangesDontIntersect(R, {0x10, 0x10}); 3092 // 1 byte of Range 3093 AssertRangesIntersect(R, {0x10, 0x11}); 3094 // same as Range 3095 AssertRangesIntersect(R, {0x10, 0x20}); 3096 // 1 byte past Range 3097 AssertRangesIntersect(R, {0x10, 0x21}); 3098 3099 //---------------------------------------------------------------------- 3100 // Test ranges that start inside Range 3101 //---------------------------------------------------------------------- 3102 // empty in range 3103 AssertRangesDontIntersect(R, {0x11, 0x11}); 3104 // all in Range 3105 AssertRangesIntersect(R, {0x11, 0x1f}); 3106 // ends at end of Range 3107 AssertRangesIntersect(R, {0x11, 0x20}); 3108 // ends past Range 3109 AssertRangesIntersect(R, {0x11, 0x21}); 3110 3111 //---------------------------------------------------------------------- 3112 // Test ranges that start at last bytes of Range 3113 //---------------------------------------------------------------------- 3114 // ends at end of Range 3115 AssertRangesIntersect(R, {0x1f, 0x20}); 3116 // ends past Range 3117 AssertRangesIntersect(R, {0x1f, 0x21}); 3118 3119 //---------------------------------------------------------------------- 3120 // Test ranges that start after Range 3121 //---------------------------------------------------------------------- 3122 // empty just past in Range 3123 AssertRangesDontIntersect(R, {0x20, 0x20}); 3124 // valid past Range 3125 AssertRangesDontIntersect(R, {0x20, 0x21}); 3126 } 3127 3128 TEST(DWARFDebugInfo, TestDWARFDieRangeInfoIntersects) { 3129 3130 DWARFVerifier::DieRangeInfo Ranges({{0x10, 0x20}, {0x30, 0x40}}); 3131 3132 // Test empty range 3133 AssertRangesDontIntersect(Ranges, {}); 3134 // Test range that appears before all ranges in Ranges 3135 AssertRangesDontIntersect(Ranges, {{0x00, 0x10}}); 3136 // Test range that appears between ranges in Ranges 3137 AssertRangesDontIntersect(Ranges, {{0x20, 0x30}}); 3138 // Test range that appears after ranges in Ranges 3139 AssertRangesDontIntersect(Ranges, {{0x40, 0x50}}); 3140 3141 // Test range that start before first range 3142 AssertRangesIntersect(Ranges, {{0x00, 0x11}}); 3143 // Test range that start at first range 3144 AssertRangesIntersect(Ranges, {{0x10, 0x11}}); 3145 // Test range that start in first range 3146 AssertRangesIntersect(Ranges, {{0x11, 0x12}}); 3147 // Test range that start at end of first range 3148 AssertRangesIntersect(Ranges, {{0x1f, 0x20}}); 3149 // Test range that starts at end of first range 3150 AssertRangesDontIntersect(Ranges, {{0x20, 0x21}}); 3151 // Test range that starts at end of first range 3152 AssertRangesIntersect(Ranges, {{0x20, 0x31}}); 3153 3154 // Test range that start before second range and ends before second 3155 AssertRangesDontIntersect(Ranges, {{0x2f, 0x30}}); 3156 // Test range that start before second range and ends in second 3157 AssertRangesIntersect(Ranges, {{0x2f, 0x31}}); 3158 // Test range that start at second range 3159 AssertRangesIntersect(Ranges, {{0x30, 0x31}}); 3160 // Test range that start in second range 3161 AssertRangesIntersect(Ranges, {{0x31, 0x32}}); 3162 // Test range that start at end of second range 3163 AssertRangesIntersect(Ranges, {{0x3f, 0x40}}); 3164 // Test range that starts at end of second range 3165 AssertRangesDontIntersect(Ranges, {{0x40, 0x41}}); 3166 3167 AssertRangesDontIntersect(Ranges, {{0x20, 0x21}, {0x2f, 0x30}}); 3168 AssertRangesIntersect(Ranges, {{0x20, 0x21}, {0x2f, 0x31}}); 3169 } 3170 3171 TEST(DWARFDebugInfo, TestDWARF64UnitLength) { 3172 static const char DebugInfoSecRaw[] = 3173 "\xff\xff\xff\xff" // DWARF64 mark 3174 "\x88\x77\x66\x55\x44\x33\x22\x11" // Length 3175 "\x05\x00" // Version 3176 "\x01" // DW_UT_compile 3177 "\x04" // Address size 3178 "\0\0\0\0\0\0\0\0"; // Offset Into Abbrev. Sec. 3179 StringMap<std::unique_ptr<MemoryBuffer>> Sections; 3180 Sections.insert(std::make_pair( 3181 "debug_info", MemoryBuffer::getMemBuffer(StringRef( 3182 DebugInfoSecRaw, sizeof(DebugInfoSecRaw) - 1)))); 3183 auto Context = DWARFContext::create(Sections, /* AddrSize = */ 4, 3184 /* isLittleEndian = */ true); 3185 const auto &Obj = Context->getDWARFObj(); 3186 Obj.forEachInfoSections([&](const DWARFSection &Sec) { 3187 DWARFUnitHeader Header; 3188 DWARFDataExtractor Data(Obj, Sec, /* IsLittleEndian = */ true, 3189 /* AddressSize = */ 4); 3190 uint64_t Offset = 0; 3191 EXPECT_FALSE(Header.extract(*Context, Data, &Offset, DW_SECT_INFO)); 3192 // Header.extract() returns false because there is not enough space 3193 // in the section for the declared length. Anyway, we can check that 3194 // the properties are read correctly. 3195 ASSERT_EQ(DwarfFormat::DWARF64, Header.getFormat()); 3196 ASSERT_EQ(0x1122334455667788ULL, Header.getLength()); 3197 ASSERT_EQ(5, Header.getVersion()); 3198 ASSERT_EQ(DW_UT_compile, Header.getUnitType()); 3199 ASSERT_EQ(4, Header.getAddressByteSize()); 3200 3201 // Check that the length can be correctly read in the unit class. 3202 DWARFUnitVector DummyUnitVector; 3203 DWARFSection DummySec; 3204 DWARFCompileUnit CU(*Context, Sec, Header, /* DA = */ 0, /* RS = */ 0, 3205 /* LocSection = */ 0, /* SS = */ StringRef(), 3206 /* SOS = */ DummySec, /* AOS = */ 0, 3207 /* LS = */ DummySec, /* LE = */ true, 3208 /* isDWO= */ false, DummyUnitVector); 3209 ASSERT_EQ(0x1122334455667788ULL, CU.getLength()); 3210 }); 3211 } 3212 3213 } // end anonymous namespace 3214