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 using ::testing::HasSubstr; 40 41 namespace { 42 43 template <uint16_t Version, class AddrType, class RefAddrType> 44 void TestAllForms() { 45 Triple Triple = getDefaultTargetTripleForAddrSize(sizeof(AddrType)); 46 if (!isObjectEmissionSupported(Triple)) 47 return; 48 49 // Test that we can decode all DW_FORM values correctly. 50 const AddrType AddrValue = (AddrType)0x0123456789abcdefULL; 51 const uint8_t BlockData[] = {1, 2, 3, 4, 5, 6, 7, 8, 9, 0}; 52 const uint32_t BlockSize = sizeof(BlockData); 53 const RefAddrType RefAddr = 0x12345678; 54 const uint8_t Data1 = 0x01U; 55 const uint16_t Data2 = 0x2345U; 56 const uint32_t Data4 = 0x6789abcdU; 57 const uint64_t Data8 = 0x0011223344556677ULL; 58 const uint64_t Data8_2 = 0xAABBCCDDEEFF0011ULL; 59 const uint8_t Data16[16] = {1, 2, 3, 4, 5, 6, 7, 8, 60 9, 10, 11, 12, 13, 14, 15, 16}; 61 const int64_t SData = INT64_MIN; 62 const int64_t ICSData = INT64_MAX; // DW_FORM_implicit_const SData 63 const uint64_t UData[] = {UINT64_MAX - 1, UINT64_MAX - 2, UINT64_MAX - 3, 64 UINT64_MAX - 4, UINT64_MAX - 5, UINT64_MAX - 6, 65 UINT64_MAX - 7, UINT64_MAX - 8, UINT64_MAX - 9}; 66 #define UDATA_1 18446744073709551614ULL 67 const uint32_t Dwarf32Values[] = {1, 2, 3, 4, 5, 6, 7, 8}; 68 const char *StringValue = "Hello"; 69 const char *StrpValue = "World"; 70 const char *StrxValue = "Indexed"; 71 const char *Strx1Value = "Indexed1"; 72 const char *Strx2Value = "Indexed2"; 73 const char *Strx3Value = "Indexed3"; 74 const char *Strx4Value = "Indexed4"; 75 76 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 77 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 78 dwarfgen::Generator *DG = ExpectedDG.get().get(); 79 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 80 dwarfgen::DIE CUDie = CU.getUnitDIE(); 81 82 if (Version >= 5) 83 CUDie.addStrOffsetsBaseAttribute(); 84 85 uint16_t Attr = DW_AT_lo_user; 86 87 //---------------------------------------------------------------------- 88 // Test address forms 89 //---------------------------------------------------------------------- 90 const auto Attr_DW_FORM_addr = static_cast<dwarf::Attribute>(Attr++); 91 CUDie.addAttribute(Attr_DW_FORM_addr, DW_FORM_addr, AddrValue); 92 93 //---------------------------------------------------------------------- 94 // Test block forms 95 //---------------------------------------------------------------------- 96 const auto Attr_DW_FORM_block = static_cast<dwarf::Attribute>(Attr++); 97 CUDie.addAttribute(Attr_DW_FORM_block, DW_FORM_block, BlockData, BlockSize); 98 99 const auto Attr_DW_FORM_block1 = static_cast<dwarf::Attribute>(Attr++); 100 CUDie.addAttribute(Attr_DW_FORM_block1, DW_FORM_block1, BlockData, BlockSize); 101 102 const auto Attr_DW_FORM_block2 = static_cast<dwarf::Attribute>(Attr++); 103 CUDie.addAttribute(Attr_DW_FORM_block2, DW_FORM_block2, BlockData, BlockSize); 104 105 const auto Attr_DW_FORM_block4 = static_cast<dwarf::Attribute>(Attr++); 106 CUDie.addAttribute(Attr_DW_FORM_block4, DW_FORM_block4, BlockData, BlockSize); 107 108 // We handle data16 as a block form. 109 const auto Attr_DW_FORM_data16 = static_cast<dwarf::Attribute>(Attr++); 110 if (Version >= 5) 111 CUDie.addAttribute(Attr_DW_FORM_data16, DW_FORM_data16, Data16, 16); 112 113 //---------------------------------------------------------------------- 114 // Test data forms 115 //---------------------------------------------------------------------- 116 const auto Attr_DW_FORM_data1 = static_cast<dwarf::Attribute>(Attr++); 117 CUDie.addAttribute(Attr_DW_FORM_data1, DW_FORM_data1, Data1); 118 119 const auto Attr_DW_FORM_data2 = static_cast<dwarf::Attribute>(Attr++); 120 CUDie.addAttribute(Attr_DW_FORM_data2, DW_FORM_data2, Data2); 121 122 const auto Attr_DW_FORM_data4 = static_cast<dwarf::Attribute>(Attr++); 123 CUDie.addAttribute(Attr_DW_FORM_data4, DW_FORM_data4, Data4); 124 125 const auto Attr_DW_FORM_data8 = static_cast<dwarf::Attribute>(Attr++); 126 CUDie.addAttribute(Attr_DW_FORM_data8, DW_FORM_data8, Data8); 127 128 //---------------------------------------------------------------------- 129 // Test string forms 130 //---------------------------------------------------------------------- 131 const auto Attr_DW_FORM_string = static_cast<dwarf::Attribute>(Attr++); 132 CUDie.addAttribute(Attr_DW_FORM_string, DW_FORM_string, StringValue); 133 134 const auto Attr_DW_FORM_strx = static_cast<dwarf::Attribute>(Attr++); 135 const auto Attr_DW_FORM_strx1 = static_cast<dwarf::Attribute>(Attr++); 136 const auto Attr_DW_FORM_strx2 = static_cast<dwarf::Attribute>(Attr++); 137 const auto Attr_DW_FORM_strx3 = static_cast<dwarf::Attribute>(Attr++); 138 const auto Attr_DW_FORM_strx4 = static_cast<dwarf::Attribute>(Attr++); 139 if (Version >= 5) { 140 CUDie.addAttribute(Attr_DW_FORM_strx, DW_FORM_strx, StrxValue); 141 CUDie.addAttribute(Attr_DW_FORM_strx1, DW_FORM_strx1, Strx1Value); 142 CUDie.addAttribute(Attr_DW_FORM_strx2, DW_FORM_strx2, Strx2Value); 143 CUDie.addAttribute(Attr_DW_FORM_strx3, DW_FORM_strx3, Strx3Value); 144 CUDie.addAttribute(Attr_DW_FORM_strx4, DW_FORM_strx4, Strx4Value); 145 } 146 147 const auto Attr_DW_FORM_strp = static_cast<dwarf::Attribute>(Attr++); 148 CUDie.addAttribute(Attr_DW_FORM_strp, DW_FORM_strp, StrpValue); 149 150 //---------------------------------------------------------------------- 151 // Test reference forms 152 //---------------------------------------------------------------------- 153 const auto Attr_DW_FORM_ref_addr = static_cast<dwarf::Attribute>(Attr++); 154 CUDie.addAttribute(Attr_DW_FORM_ref_addr, DW_FORM_ref_addr, RefAddr); 155 156 const auto Attr_DW_FORM_ref1 = static_cast<dwarf::Attribute>(Attr++); 157 CUDie.addAttribute(Attr_DW_FORM_ref1, DW_FORM_ref1, Data1); 158 159 const auto Attr_DW_FORM_ref2 = static_cast<dwarf::Attribute>(Attr++); 160 CUDie.addAttribute(Attr_DW_FORM_ref2, DW_FORM_ref2, Data2); 161 162 const auto Attr_DW_FORM_ref4 = static_cast<dwarf::Attribute>(Attr++); 163 CUDie.addAttribute(Attr_DW_FORM_ref4, DW_FORM_ref4, Data4); 164 165 const auto Attr_DW_FORM_ref8 = static_cast<dwarf::Attribute>(Attr++); 166 CUDie.addAttribute(Attr_DW_FORM_ref8, DW_FORM_ref8, Data8); 167 168 const auto Attr_DW_FORM_ref_sig8 = static_cast<dwarf::Attribute>(Attr++); 169 if (Version >= 4) 170 CUDie.addAttribute(Attr_DW_FORM_ref_sig8, DW_FORM_ref_sig8, Data8_2); 171 172 const auto Attr_DW_FORM_ref_udata = static_cast<dwarf::Attribute>(Attr++); 173 CUDie.addAttribute(Attr_DW_FORM_ref_udata, DW_FORM_ref_udata, UData[0]); 174 175 //---------------------------------------------------------------------- 176 // Test flag forms 177 //---------------------------------------------------------------------- 178 const auto Attr_DW_FORM_flag_true = static_cast<dwarf::Attribute>(Attr++); 179 CUDie.addAttribute(Attr_DW_FORM_flag_true, DW_FORM_flag, true); 180 181 const auto Attr_DW_FORM_flag_false = static_cast<dwarf::Attribute>(Attr++); 182 CUDie.addAttribute(Attr_DW_FORM_flag_false, DW_FORM_flag, false); 183 184 const auto Attr_DW_FORM_flag_present = static_cast<dwarf::Attribute>(Attr++); 185 if (Version >= 4) 186 CUDie.addAttribute(Attr_DW_FORM_flag_present, DW_FORM_flag_present); 187 188 //---------------------------------------------------------------------- 189 // Test SLEB128 based forms 190 //---------------------------------------------------------------------- 191 const auto Attr_DW_FORM_sdata = static_cast<dwarf::Attribute>(Attr++); 192 CUDie.addAttribute(Attr_DW_FORM_sdata, DW_FORM_sdata, SData); 193 194 const auto Attr_DW_FORM_implicit_const = 195 static_cast<dwarf::Attribute>(Attr++); 196 if (Version >= 5) 197 CUDie.addAttribute(Attr_DW_FORM_implicit_const, DW_FORM_implicit_const, 198 ICSData); 199 200 //---------------------------------------------------------------------- 201 // Test ULEB128 based forms 202 //---------------------------------------------------------------------- 203 const auto Attr_DW_FORM_udata = static_cast<dwarf::Attribute>(Attr++); 204 CUDie.addAttribute(Attr_DW_FORM_udata, DW_FORM_udata, UData[0]); 205 206 //---------------------------------------------------------------------- 207 // Test DWARF32/DWARF64 forms 208 //---------------------------------------------------------------------- 209 const auto Attr_DW_FORM_GNU_ref_alt = static_cast<dwarf::Attribute>(Attr++); 210 CUDie.addAttribute(Attr_DW_FORM_GNU_ref_alt, DW_FORM_GNU_ref_alt, 211 Dwarf32Values[0]); 212 213 const auto Attr_DW_FORM_sec_offset = static_cast<dwarf::Attribute>(Attr++); 214 if (Version >= 4) 215 CUDie.addAttribute(Attr_DW_FORM_sec_offset, DW_FORM_sec_offset, 216 Dwarf32Values[1]); 217 218 //---------------------------------------------------------------------- 219 // Add an address at the end to make sure we can decode this value 220 //---------------------------------------------------------------------- 221 const auto Attr_Last = static_cast<dwarf::Attribute>(Attr++); 222 CUDie.addAttribute(Attr_Last, DW_FORM_addr, AddrValue); 223 224 //---------------------------------------------------------------------- 225 // Generate the DWARF 226 //---------------------------------------------------------------------- 227 StringRef FileBytes = DG->generate(); 228 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 229 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 230 EXPECT_TRUE((bool)Obj); 231 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 232 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 233 EXPECT_EQ(NumCUs, 1u); 234 DWARFCompileUnit *U = 235 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 236 auto DieDG = U->getUnitDIE(false); 237 EXPECT_TRUE(DieDG.isValid()); 238 239 //---------------------------------------------------------------------- 240 // Test address forms 241 //---------------------------------------------------------------------- 242 EXPECT_EQ(AddrValue, toAddress(DieDG.find(Attr_DW_FORM_addr), 0)); 243 244 //---------------------------------------------------------------------- 245 // Test block forms 246 //---------------------------------------------------------------------- 247 Optional<DWARFFormValue> FormValue; 248 ArrayRef<uint8_t> ExtractedBlockData; 249 Optional<ArrayRef<uint8_t>> BlockDataOpt; 250 251 FormValue = DieDG.find(Attr_DW_FORM_block); 252 EXPECT_TRUE((bool)FormValue); 253 BlockDataOpt = FormValue->getAsBlock(); 254 EXPECT_TRUE(BlockDataOpt.hasValue()); 255 ExtractedBlockData = BlockDataOpt.getValue(); 256 EXPECT_EQ(ExtractedBlockData.size(), BlockSize); 257 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), BlockData, BlockSize) == 0); 258 259 FormValue = DieDG.find(Attr_DW_FORM_block1); 260 EXPECT_TRUE((bool)FormValue); 261 BlockDataOpt = FormValue->getAsBlock(); 262 EXPECT_TRUE(BlockDataOpt.hasValue()); 263 ExtractedBlockData = BlockDataOpt.getValue(); 264 EXPECT_EQ(ExtractedBlockData.size(), BlockSize); 265 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), BlockData, BlockSize) == 0); 266 267 FormValue = DieDG.find(Attr_DW_FORM_block2); 268 EXPECT_TRUE((bool)FormValue); 269 BlockDataOpt = FormValue->getAsBlock(); 270 EXPECT_TRUE(BlockDataOpt.hasValue()); 271 ExtractedBlockData = BlockDataOpt.getValue(); 272 EXPECT_EQ(ExtractedBlockData.size(), BlockSize); 273 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), BlockData, BlockSize) == 0); 274 275 FormValue = DieDG.find(Attr_DW_FORM_block4); 276 EXPECT_TRUE((bool)FormValue); 277 BlockDataOpt = FormValue->getAsBlock(); 278 EXPECT_TRUE(BlockDataOpt.hasValue()); 279 ExtractedBlockData = BlockDataOpt.getValue(); 280 EXPECT_EQ(ExtractedBlockData.size(), BlockSize); 281 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), BlockData, BlockSize) == 0); 282 283 // Data16 is handled like a block. 284 if (Version >= 5) { 285 FormValue = DieDG.find(Attr_DW_FORM_data16); 286 EXPECT_TRUE((bool)FormValue); 287 BlockDataOpt = FormValue->getAsBlock(); 288 EXPECT_TRUE(BlockDataOpt.hasValue()); 289 ExtractedBlockData = BlockDataOpt.getValue(); 290 EXPECT_EQ(ExtractedBlockData.size(), 16u); 291 EXPECT_TRUE(memcmp(ExtractedBlockData.data(), Data16, 16) == 0); 292 } 293 294 //---------------------------------------------------------------------- 295 // Test data forms 296 //---------------------------------------------------------------------- 297 EXPECT_EQ(Data1, toUnsigned(DieDG.find(Attr_DW_FORM_data1), 0)); 298 EXPECT_EQ(Data2, toUnsigned(DieDG.find(Attr_DW_FORM_data2), 0)); 299 EXPECT_EQ(Data4, toUnsigned(DieDG.find(Attr_DW_FORM_data4), 0)); 300 EXPECT_EQ(Data8, toUnsigned(DieDG.find(Attr_DW_FORM_data8), 0)); 301 302 //---------------------------------------------------------------------- 303 // Test string forms 304 //---------------------------------------------------------------------- 305 auto ExtractedStringValue = toString(DieDG.find(Attr_DW_FORM_string)); 306 EXPECT_TRUE((bool)ExtractedStringValue); 307 EXPECT_STREQ(StringValue, *ExtractedStringValue); 308 309 if (Version >= 5) { 310 auto ExtractedStrxValue = toString(DieDG.find(Attr_DW_FORM_strx)); 311 EXPECT_TRUE((bool)ExtractedStrxValue); 312 EXPECT_STREQ(StrxValue, *ExtractedStrxValue); 313 314 auto ExtractedStrx1Value = toString(DieDG.find(Attr_DW_FORM_strx1)); 315 EXPECT_TRUE((bool)ExtractedStrx1Value); 316 EXPECT_STREQ(Strx1Value, *ExtractedStrx1Value); 317 318 auto ExtractedStrx2Value = toString(DieDG.find(Attr_DW_FORM_strx2)); 319 EXPECT_TRUE((bool)ExtractedStrx2Value); 320 EXPECT_STREQ(Strx2Value, *ExtractedStrx2Value); 321 322 auto ExtractedStrx3Value = toString(DieDG.find(Attr_DW_FORM_strx3)); 323 EXPECT_TRUE((bool)ExtractedStrx3Value); 324 EXPECT_STREQ(Strx3Value, *ExtractedStrx3Value); 325 326 auto ExtractedStrx4Value = toString(DieDG.find(Attr_DW_FORM_strx4)); 327 EXPECT_TRUE((bool)ExtractedStrx4Value); 328 EXPECT_STREQ(Strx4Value, *ExtractedStrx4Value); 329 } 330 331 auto ExtractedStrpValue = toString(DieDG.find(Attr_DW_FORM_strp)); 332 EXPECT_TRUE((bool)ExtractedStrpValue); 333 EXPECT_STREQ(StrpValue, *ExtractedStrpValue); 334 335 //---------------------------------------------------------------------- 336 // Test reference forms 337 //---------------------------------------------------------------------- 338 EXPECT_EQ(RefAddr, toReference(DieDG.find(Attr_DW_FORM_ref_addr), 0)); 339 EXPECT_EQ(Data1, toReference(DieDG.find(Attr_DW_FORM_ref1), 0)); 340 EXPECT_EQ(Data2, toReference(DieDG.find(Attr_DW_FORM_ref2), 0)); 341 EXPECT_EQ(Data4, toReference(DieDG.find(Attr_DW_FORM_ref4), 0)); 342 EXPECT_EQ(Data8, toReference(DieDG.find(Attr_DW_FORM_ref8), 0)); 343 if (Version >= 4) { 344 EXPECT_EQ(Data8_2, toReference(DieDG.find(Attr_DW_FORM_ref_sig8), 0)); 345 } 346 EXPECT_EQ(UData[0], toReference(DieDG.find(Attr_DW_FORM_ref_udata), 0)); 347 348 //---------------------------------------------------------------------- 349 // Test flag forms 350 //---------------------------------------------------------------------- 351 EXPECT_EQ(1ULL, toUnsigned(DieDG.find(Attr_DW_FORM_flag_true), 0)); 352 EXPECT_EQ(0ULL, toUnsigned(DieDG.find(Attr_DW_FORM_flag_false), 1)); 353 if (Version >= 4) { 354 EXPECT_EQ(1ULL, toUnsigned(DieDG.find(Attr_DW_FORM_flag_present), 0)); 355 } 356 357 //---------------------------------------------------------------------- 358 // Test SLEB128 based forms 359 //---------------------------------------------------------------------- 360 EXPECT_EQ(SData, toSigned(DieDG.find(Attr_DW_FORM_sdata), 0)); 361 if (Version >= 5) { 362 EXPECT_EQ(ICSData, toSigned(DieDG.find(Attr_DW_FORM_implicit_const), 0)); 363 } 364 365 //---------------------------------------------------------------------- 366 // Test ULEB128 based forms 367 //---------------------------------------------------------------------- 368 EXPECT_EQ(UData[0], toUnsigned(DieDG.find(Attr_DW_FORM_udata), 0)); 369 370 //---------------------------------------------------------------------- 371 // Test DWARF32/DWARF64 forms 372 //---------------------------------------------------------------------- 373 EXPECT_EQ(Dwarf32Values[0], 374 toReference(DieDG.find(Attr_DW_FORM_GNU_ref_alt), 0)); 375 if (Version >= 4) { 376 EXPECT_EQ(Dwarf32Values[1], 377 toSectionOffset(DieDG.find(Attr_DW_FORM_sec_offset), 0)); 378 } 379 380 //---------------------------------------------------------------------- 381 // Add an address at the end to make sure we can decode this value 382 //---------------------------------------------------------------------- 383 EXPECT_EQ(AddrValue, toAddress(DieDG.find(Attr_Last), 0)); 384 } 385 386 TEST(DWARFDebugInfo, TestDWARF32Version2Addr4AllForms) { 387 // Test that we can decode all forms for DWARF32, version 2, with 4 byte 388 // addresses. 389 typedef uint32_t AddrType; 390 // DW_FORM_ref_addr are the same as the address type in DWARF32 version 2. 391 typedef AddrType RefAddrType; 392 TestAllForms<2, AddrType, RefAddrType>(); 393 } 394 395 TEST(DWARFDebugInfo, TestDWARF32Version2Addr8AllForms) { 396 // Test that we can decode all forms for DWARF32, version 2, with 4 byte 397 // addresses. 398 typedef uint64_t AddrType; 399 // DW_FORM_ref_addr are the same as the address type in DWARF32 version 2. 400 typedef AddrType RefAddrType; 401 TestAllForms<2, AddrType, RefAddrType>(); 402 } 403 404 TEST(DWARFDebugInfo, TestDWARF32Version3Addr4AllForms) { 405 // Test that we can decode all forms for DWARF32, version 3, with 4 byte 406 // addresses. 407 typedef uint32_t AddrType; 408 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later. 409 typedef uint32_t RefAddrType; 410 TestAllForms<3, AddrType, RefAddrType>(); 411 } 412 413 TEST(DWARFDebugInfo, TestDWARF32Version3Addr8AllForms) { 414 // Test that we can decode all forms for DWARF32, version 3, with 8 byte 415 // addresses. 416 typedef uint64_t AddrType; 417 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 418 typedef uint32_t RefAddrType; 419 TestAllForms<3, AddrType, RefAddrType>(); 420 } 421 422 TEST(DWARFDebugInfo, TestDWARF32Version4Addr4AllForms) { 423 // Test that we can decode all forms for DWARF32, version 4, with 4 byte 424 // addresses. 425 typedef uint32_t AddrType; 426 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 427 typedef uint32_t RefAddrType; 428 TestAllForms<4, AddrType, RefAddrType>(); 429 } 430 431 TEST(DWARFDebugInfo, TestDWARF32Version4Addr8AllForms) { 432 // Test that we can decode all forms for DWARF32, version 4, with 8 byte 433 // addresses. 434 typedef uint64_t AddrType; 435 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 436 typedef uint32_t RefAddrType; 437 TestAllForms<4, AddrType, RefAddrType>(); 438 } 439 440 TEST(DWARFDebugInfo, TestDWARF32Version5Addr4AllForms) { 441 // Test that we can decode all forms for DWARF32, version 5, with 4 byte 442 // addresses. 443 typedef uint32_t AddrType; 444 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 445 typedef uint32_t RefAddrType; 446 TestAllForms<5, AddrType, RefAddrType>(); 447 } 448 449 TEST(DWARFDebugInfo, TestDWARF32Version5Addr8AllForms) { 450 // Test that we can decode all forms for DWARF32, version 5, with 8 byte 451 // addresses. 452 typedef uint64_t AddrType; 453 // DW_FORM_ref_addr are 4 bytes in DWARF32 for version 3 and later 454 typedef uint32_t RefAddrType; 455 TestAllForms<5, AddrType, RefAddrType>(); 456 } 457 458 template <uint16_t Version, class AddrType> void TestChildren() { 459 Triple Triple = getDefaultTargetTripleForAddrSize(sizeof(AddrType)); 460 if (!isObjectEmissionSupported(Triple)) 461 return; 462 463 // Test that we can decode DW_FORM_ref_addr values correctly in DWARF 2 with 464 // 4 byte addresses. DW_FORM_ref_addr values should be 4 bytes when using 465 // 8 byte addresses. 466 467 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 468 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 469 dwarfgen::Generator *DG = ExpectedDG.get().get(); 470 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 471 dwarfgen::DIE CUDie = CU.getUnitDIE(); 472 473 CUDie.addAttribute(DW_AT_name, DW_FORM_strp, "/tmp/main.c"); 474 CUDie.addAttribute(DW_AT_language, DW_FORM_data2, DW_LANG_C); 475 476 dwarfgen::DIE SubprogramDie = CUDie.addChild(DW_TAG_subprogram); 477 SubprogramDie.addAttribute(DW_AT_name, DW_FORM_strp, "main"); 478 SubprogramDie.addAttribute(DW_AT_low_pc, DW_FORM_addr, 0x1000U); 479 SubprogramDie.addAttribute(DW_AT_high_pc, DW_FORM_addr, 0x2000U); 480 481 dwarfgen::DIE IntDie = CUDie.addChild(DW_TAG_base_type); 482 IntDie.addAttribute(DW_AT_name, DW_FORM_strp, "int"); 483 IntDie.addAttribute(DW_AT_encoding, DW_FORM_data1, DW_ATE_signed); 484 IntDie.addAttribute(DW_AT_byte_size, DW_FORM_data1, 4); 485 486 dwarfgen::DIE ArgcDie = SubprogramDie.addChild(DW_TAG_formal_parameter); 487 ArgcDie.addAttribute(DW_AT_name, DW_FORM_strp, "argc"); 488 // ArgcDie.addAttribute(DW_AT_type, DW_FORM_ref4, IntDie); 489 ArgcDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, IntDie); 490 491 StringRef FileBytes = DG->generate(); 492 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 493 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 494 EXPECT_TRUE((bool)Obj); 495 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 496 497 // Verify the number of compile units is correct. 498 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 499 EXPECT_EQ(NumCUs, 1u); 500 DWARFCompileUnit *U = 501 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 502 503 // Get the compile unit DIE is valid. 504 auto DieDG = U->getUnitDIE(false); 505 EXPECT_TRUE(DieDG.isValid()); 506 507 // Verify the first child of the compile unit DIE is our subprogram. 508 auto SubprogramDieDG = DieDG.getFirstChild(); 509 EXPECT_TRUE(SubprogramDieDG.isValid()); 510 EXPECT_EQ(SubprogramDieDG.getTag(), DW_TAG_subprogram); 511 512 // Verify the first child of the subprogram is our formal parameter. 513 auto ArgcDieDG = SubprogramDieDG.getFirstChild(); 514 EXPECT_TRUE(ArgcDieDG.isValid()); 515 EXPECT_EQ(ArgcDieDG.getTag(), DW_TAG_formal_parameter); 516 517 // Verify our formal parameter has a NULL tag sibling. 518 auto NullDieDG = ArgcDieDG.getSibling(); 519 EXPECT_TRUE(NullDieDG.isValid()); 520 if (NullDieDG) { 521 EXPECT_EQ(NullDieDG.getTag(), DW_TAG_null); 522 EXPECT_TRUE(!NullDieDG.getSibling().isValid()); 523 EXPECT_TRUE(!NullDieDG.getFirstChild().isValid()); 524 } 525 526 // Verify the sibling of our subprogram is our integer base type. 527 auto IntDieDG = SubprogramDieDG.getSibling(); 528 EXPECT_TRUE(IntDieDG.isValid()); 529 EXPECT_EQ(IntDieDG.getTag(), DW_TAG_base_type); 530 531 // Verify the sibling of our subprogram is our integer base is a NULL tag. 532 NullDieDG = IntDieDG.getSibling(); 533 EXPECT_TRUE(NullDieDG.isValid()); 534 if (NullDieDG) { 535 EXPECT_EQ(NullDieDG.getTag(), DW_TAG_null); 536 EXPECT_TRUE(!NullDieDG.getSibling().isValid()); 537 EXPECT_TRUE(!NullDieDG.getFirstChild().isValid()); 538 } 539 540 // Verify the previous sibling of our subprogram is our integer base type. 541 IntDieDG = NullDieDG.getPreviousSibling(); 542 EXPECT_TRUE(IntDieDG.isValid()); 543 EXPECT_EQ(IntDieDG.getTag(), DW_TAG_base_type); 544 } 545 546 TEST(DWARFDebugInfo, TestDWARF32Version2Addr4Children) { 547 // Test that we can decode all forms for DWARF32, version 2, with 4 byte 548 // addresses. 549 typedef uint32_t AddrType; 550 TestChildren<2, AddrType>(); 551 } 552 553 TEST(DWARFDebugInfo, TestDWARF32Version2Addr8Children) { 554 // Test that we can decode all forms for DWARF32, version 2, with 8 byte 555 // addresses. 556 typedef uint64_t AddrType; 557 TestChildren<2, AddrType>(); 558 } 559 560 TEST(DWARFDebugInfo, TestDWARF32Version3Addr4Children) { 561 // Test that we can decode all forms for DWARF32, version 3, with 4 byte 562 // addresses. 563 typedef uint32_t AddrType; 564 TestChildren<3, AddrType>(); 565 } 566 567 TEST(DWARFDebugInfo, TestDWARF32Version3Addr8Children) { 568 // Test that we can decode all forms for DWARF32, version 3, with 8 byte 569 // addresses. 570 typedef uint64_t AddrType; 571 TestChildren<3, AddrType>(); 572 } 573 574 TEST(DWARFDebugInfo, TestDWARF32Version4Addr4Children) { 575 // Test that we can decode all forms for DWARF32, version 4, with 4 byte 576 // addresses. 577 typedef uint32_t AddrType; 578 TestChildren<4, AddrType>(); 579 } 580 581 TEST(DWARFDebugInfo, TestDWARF32Version4Addr8Children) { 582 // Test that we can decode all forms for DWARF32, version 4, with 8 byte 583 // addresses. 584 typedef uint64_t AddrType; 585 TestChildren<4, AddrType>(); 586 } 587 588 template <uint16_t Version, class AddrType> void TestReferences() { 589 Triple Triple = getDefaultTargetTripleForAddrSize(sizeof(AddrType)); 590 if (!isObjectEmissionSupported(Triple)) 591 return; 592 593 // Test that we can decode DW_FORM_refXXX values correctly in DWARF. 594 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 595 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 596 dwarfgen::Generator *DG = ExpectedDG.get().get(); 597 dwarfgen::CompileUnit &CU1 = DG->addCompileUnit(); 598 dwarfgen::CompileUnit &CU2 = DG->addCompileUnit(); 599 600 dwarfgen::DIE CU1Die = CU1.getUnitDIE(); 601 CU1Die.addAttribute(DW_AT_name, DW_FORM_strp, "/tmp/main.c"); 602 CU1Die.addAttribute(DW_AT_language, DW_FORM_data2, DW_LANG_C); 603 604 dwarfgen::DIE CU1TypeDie = CU1Die.addChild(DW_TAG_base_type); 605 CU1TypeDie.addAttribute(DW_AT_name, DW_FORM_strp, "int"); 606 CU1TypeDie.addAttribute(DW_AT_encoding, DW_FORM_data1, DW_ATE_signed); 607 CU1TypeDie.addAttribute(DW_AT_byte_size, DW_FORM_data1, 4); 608 609 dwarfgen::DIE CU1Ref1Die = CU1Die.addChild(DW_TAG_variable); 610 CU1Ref1Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU1Ref1"); 611 CU1Ref1Die.addAttribute(DW_AT_type, DW_FORM_ref1, CU1TypeDie); 612 613 dwarfgen::DIE CU1Ref2Die = CU1Die.addChild(DW_TAG_variable); 614 CU1Ref2Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU1Ref2"); 615 CU1Ref2Die.addAttribute(DW_AT_type, DW_FORM_ref2, CU1TypeDie); 616 617 dwarfgen::DIE CU1Ref4Die = CU1Die.addChild(DW_TAG_variable); 618 CU1Ref4Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU1Ref4"); 619 CU1Ref4Die.addAttribute(DW_AT_type, DW_FORM_ref4, CU1TypeDie); 620 621 dwarfgen::DIE CU1Ref8Die = CU1Die.addChild(DW_TAG_variable); 622 CU1Ref8Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU1Ref8"); 623 CU1Ref8Die.addAttribute(DW_AT_type, DW_FORM_ref8, CU1TypeDie); 624 625 dwarfgen::DIE CU1RefAddrDie = CU1Die.addChild(DW_TAG_variable); 626 CU1RefAddrDie.addAttribute(DW_AT_name, DW_FORM_strp, "CU1RefAddr"); 627 CU1RefAddrDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, CU1TypeDie); 628 629 dwarfgen::DIE CU2Die = CU2.getUnitDIE(); 630 CU2Die.addAttribute(DW_AT_name, DW_FORM_strp, "/tmp/foo.c"); 631 CU2Die.addAttribute(DW_AT_language, DW_FORM_data2, DW_LANG_C); 632 633 dwarfgen::DIE CU2TypeDie = CU2Die.addChild(DW_TAG_base_type); 634 CU2TypeDie.addAttribute(DW_AT_name, DW_FORM_strp, "float"); 635 CU2TypeDie.addAttribute(DW_AT_encoding, DW_FORM_data1, DW_ATE_float); 636 CU2TypeDie.addAttribute(DW_AT_byte_size, DW_FORM_data1, 4); 637 638 dwarfgen::DIE CU2Ref1Die = CU2Die.addChild(DW_TAG_variable); 639 CU2Ref1Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU2Ref1"); 640 CU2Ref1Die.addAttribute(DW_AT_type, DW_FORM_ref1, CU2TypeDie); 641 642 dwarfgen::DIE CU2Ref2Die = CU2Die.addChild(DW_TAG_variable); 643 CU2Ref2Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU2Ref2"); 644 CU2Ref2Die.addAttribute(DW_AT_type, DW_FORM_ref2, CU2TypeDie); 645 646 dwarfgen::DIE CU2Ref4Die = CU2Die.addChild(DW_TAG_variable); 647 CU2Ref4Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU2Ref4"); 648 CU2Ref4Die.addAttribute(DW_AT_type, DW_FORM_ref4, CU2TypeDie); 649 650 dwarfgen::DIE CU2Ref8Die = CU2Die.addChild(DW_TAG_variable); 651 CU2Ref8Die.addAttribute(DW_AT_name, DW_FORM_strp, "CU2Ref8"); 652 CU2Ref8Die.addAttribute(DW_AT_type, DW_FORM_ref8, CU2TypeDie); 653 654 dwarfgen::DIE CU2RefAddrDie = CU2Die.addChild(DW_TAG_variable); 655 CU2RefAddrDie.addAttribute(DW_AT_name, DW_FORM_strp, "CU2RefAddr"); 656 CU2RefAddrDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, CU2TypeDie); 657 658 // Refer to a type in CU1 from CU2 659 dwarfgen::DIE CU2ToCU1RefAddrDie = CU2Die.addChild(DW_TAG_variable); 660 CU2ToCU1RefAddrDie.addAttribute(DW_AT_name, DW_FORM_strp, "CU2ToCU1RefAddr"); 661 CU2ToCU1RefAddrDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, CU1TypeDie); 662 663 // Refer to a type in CU2 from CU1 664 dwarfgen::DIE CU1ToCU2RefAddrDie = CU1Die.addChild(DW_TAG_variable); 665 CU1ToCU2RefAddrDie.addAttribute(DW_AT_name, DW_FORM_strp, "CU1ToCU2RefAddr"); 666 CU1ToCU2RefAddrDie.addAttribute(DW_AT_type, DW_FORM_ref_addr, CU2TypeDie); 667 668 StringRef FileBytes = DG->generate(); 669 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 670 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 671 EXPECT_TRUE((bool)Obj); 672 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 673 674 // Verify the number of compile units is correct. 675 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 676 EXPECT_EQ(NumCUs, 2u); 677 DWARFCompileUnit *U1 = 678 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 679 DWARFCompileUnit *U2 = 680 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(1)); 681 682 // Get the compile unit DIE is valid. 683 auto Unit1DieDG = U1->getUnitDIE(false); 684 EXPECT_TRUE(Unit1DieDG.isValid()); 685 686 auto Unit2DieDG = U2->getUnitDIE(false); 687 EXPECT_TRUE(Unit2DieDG.isValid()); 688 689 // Verify the first child of the compile unit 1 DIE is our int base type. 690 auto CU1TypeDieDG = Unit1DieDG.getFirstChild(); 691 EXPECT_TRUE(CU1TypeDieDG.isValid()); 692 EXPECT_EQ(CU1TypeDieDG.getTag(), DW_TAG_base_type); 693 EXPECT_EQ(DW_ATE_signed, toUnsigned(CU1TypeDieDG.find(DW_AT_encoding), 0)); 694 695 // Verify the first child of the compile unit 2 DIE is our float base type. 696 auto CU2TypeDieDG = Unit2DieDG.getFirstChild(); 697 EXPECT_TRUE(CU2TypeDieDG.isValid()); 698 EXPECT_EQ(CU2TypeDieDG.getTag(), DW_TAG_base_type); 699 EXPECT_EQ(DW_ATE_float, toUnsigned(CU2TypeDieDG.find(DW_AT_encoding), 0)); 700 701 // Verify the sibling of the base type DIE is our Ref1 DIE and that its 702 // DW_AT_type points to our base type DIE. 703 auto CU1Ref1DieDG = CU1TypeDieDG.getSibling(); 704 EXPECT_TRUE(CU1Ref1DieDG.isValid()); 705 EXPECT_EQ(CU1Ref1DieDG.getTag(), DW_TAG_variable); 706 EXPECT_EQ(CU1TypeDieDG.getOffset(), 707 toReference(CU1Ref1DieDG.find(DW_AT_type), -1ULL)); 708 // Verify the sibling is our Ref2 DIE and that its DW_AT_type points to our 709 // base type DIE in CU1. 710 auto CU1Ref2DieDG = CU1Ref1DieDG.getSibling(); 711 EXPECT_TRUE(CU1Ref2DieDG.isValid()); 712 EXPECT_EQ(CU1Ref2DieDG.getTag(), DW_TAG_variable); 713 EXPECT_EQ(CU1TypeDieDG.getOffset(), 714 toReference(CU1Ref2DieDG.find(DW_AT_type), -1ULL)); 715 716 // Verify the sibling is our Ref4 DIE and that its DW_AT_type points to our 717 // base type DIE in CU1. 718 auto CU1Ref4DieDG = CU1Ref2DieDG.getSibling(); 719 EXPECT_TRUE(CU1Ref4DieDG.isValid()); 720 EXPECT_EQ(CU1Ref4DieDG.getTag(), DW_TAG_variable); 721 EXPECT_EQ(CU1TypeDieDG.getOffset(), 722 toReference(CU1Ref4DieDG.find(DW_AT_type), -1ULL)); 723 724 // Verify the sibling is our Ref8 DIE and that its DW_AT_type points to our 725 // base type DIE in CU1. 726 auto CU1Ref8DieDG = CU1Ref4DieDG.getSibling(); 727 EXPECT_TRUE(CU1Ref8DieDG.isValid()); 728 EXPECT_EQ(CU1Ref8DieDG.getTag(), DW_TAG_variable); 729 EXPECT_EQ(CU1TypeDieDG.getOffset(), 730 toReference(CU1Ref8DieDG.find(DW_AT_type), -1ULL)); 731 732 // Verify the sibling is our RefAddr DIE and that its DW_AT_type points to our 733 // base type DIE in CU1. 734 auto CU1RefAddrDieDG = CU1Ref8DieDG.getSibling(); 735 EXPECT_TRUE(CU1RefAddrDieDG.isValid()); 736 EXPECT_EQ(CU1RefAddrDieDG.getTag(), DW_TAG_variable); 737 EXPECT_EQ(CU1TypeDieDG.getOffset(), 738 toReference(CU1RefAddrDieDG.find(DW_AT_type), -1ULL)); 739 740 // Verify the sibling of the Ref4 DIE is our RefAddr DIE and that its 741 // DW_AT_type points to our base type DIE. 742 auto CU1ToCU2RefAddrDieDG = CU1RefAddrDieDG.getSibling(); 743 EXPECT_TRUE(CU1ToCU2RefAddrDieDG.isValid()); 744 EXPECT_EQ(CU1ToCU2RefAddrDieDG.getTag(), DW_TAG_variable); 745 EXPECT_EQ(CU2TypeDieDG.getOffset(), 746 toReference(CU1ToCU2RefAddrDieDG.find(DW_AT_type), -1ULL)); 747 748 // Verify the sibling of the base type DIE is our Ref1 DIE and that its 749 // DW_AT_type points to our base type DIE. 750 auto CU2Ref1DieDG = CU2TypeDieDG.getSibling(); 751 EXPECT_TRUE(CU2Ref1DieDG.isValid()); 752 EXPECT_EQ(CU2Ref1DieDG.getTag(), DW_TAG_variable); 753 EXPECT_EQ(CU2TypeDieDG.getOffset(), 754 toReference(CU2Ref1DieDG.find(DW_AT_type), -1ULL)); 755 // Verify the sibling is our Ref2 DIE and that its DW_AT_type points to our 756 // base type DIE in CU2. 757 auto CU2Ref2DieDG = CU2Ref1DieDG.getSibling(); 758 EXPECT_TRUE(CU2Ref2DieDG.isValid()); 759 EXPECT_EQ(CU2Ref2DieDG.getTag(), DW_TAG_variable); 760 EXPECT_EQ(CU2TypeDieDG.getOffset(), 761 toReference(CU2Ref2DieDG.find(DW_AT_type), -1ULL)); 762 763 // Verify the sibling is our Ref4 DIE and that its DW_AT_type points to our 764 // base type DIE in CU2. 765 auto CU2Ref4DieDG = CU2Ref2DieDG.getSibling(); 766 EXPECT_TRUE(CU2Ref4DieDG.isValid()); 767 EXPECT_EQ(CU2Ref4DieDG.getTag(), DW_TAG_variable); 768 EXPECT_EQ(CU2TypeDieDG.getOffset(), 769 toReference(CU2Ref4DieDG.find(DW_AT_type), -1ULL)); 770 771 // Verify the sibling is our Ref8 DIE and that its DW_AT_type points to our 772 // base type DIE in CU2. 773 auto CU2Ref8DieDG = CU2Ref4DieDG.getSibling(); 774 EXPECT_TRUE(CU2Ref8DieDG.isValid()); 775 EXPECT_EQ(CU2Ref8DieDG.getTag(), DW_TAG_variable); 776 EXPECT_EQ(CU2TypeDieDG.getOffset(), 777 toReference(CU2Ref8DieDG.find(DW_AT_type), -1ULL)); 778 779 // Verify the sibling is our RefAddr DIE and that its DW_AT_type points to our 780 // base type DIE in CU2. 781 auto CU2RefAddrDieDG = CU2Ref8DieDG.getSibling(); 782 EXPECT_TRUE(CU2RefAddrDieDG.isValid()); 783 EXPECT_EQ(CU2RefAddrDieDG.getTag(), DW_TAG_variable); 784 EXPECT_EQ(CU2TypeDieDG.getOffset(), 785 toReference(CU2RefAddrDieDG.find(DW_AT_type), -1ULL)); 786 787 // Verify the sibling of the Ref4 DIE is our RefAddr DIE and that its 788 // DW_AT_type points to our base type DIE. 789 auto CU2ToCU1RefAddrDieDG = CU2RefAddrDieDG.getSibling(); 790 EXPECT_TRUE(CU2ToCU1RefAddrDieDG.isValid()); 791 EXPECT_EQ(CU2ToCU1RefAddrDieDG.getTag(), DW_TAG_variable); 792 EXPECT_EQ(CU1TypeDieDG.getOffset(), 793 toReference(CU2ToCU1RefAddrDieDG.find(DW_AT_type), -1ULL)); 794 } 795 796 TEST(DWARFDebugInfo, TestDWARF32Version2Addr4References) { 797 // Test that we can decode all forms for DWARF32, version 2, with 4 byte 798 // addresses. 799 typedef uint32_t AddrType; 800 TestReferences<2, AddrType>(); 801 } 802 803 TEST(DWARFDebugInfo, TestDWARF32Version2Addr8References) { 804 // Test that we can decode all forms for DWARF32, version 2, with 8 byte 805 // addresses. 806 typedef uint64_t AddrType; 807 TestReferences<2, AddrType>(); 808 } 809 810 TEST(DWARFDebugInfo, TestDWARF32Version3Addr4References) { 811 // Test that we can decode all forms for DWARF32, version 3, with 4 byte 812 // addresses. 813 typedef uint32_t AddrType; 814 TestReferences<3, AddrType>(); 815 } 816 817 TEST(DWARFDebugInfo, TestDWARF32Version3Addr8References) { 818 // Test that we can decode all forms for DWARF32, version 3, with 8 byte 819 // addresses. 820 typedef uint64_t AddrType; 821 TestReferences<3, AddrType>(); 822 } 823 824 TEST(DWARFDebugInfo, TestDWARF32Version4Addr4References) { 825 // Test that we can decode all forms for DWARF32, version 4, with 4 byte 826 // addresses. 827 typedef uint32_t AddrType; 828 TestReferences<4, AddrType>(); 829 } 830 831 TEST(DWARFDebugInfo, TestDWARF32Version4Addr8References) { 832 // Test that we can decode all forms for DWARF32, version 4, with 8 byte 833 // addresses. 834 typedef uint64_t AddrType; 835 TestReferences<4, AddrType>(); 836 } 837 838 template <uint16_t Version, class AddrType> void TestAddresses() { 839 Triple Triple = getDefaultTargetTripleForAddrSize(sizeof(AddrType)); 840 if (!isObjectEmissionSupported(Triple)) 841 return; 842 843 // Test the DWARF APIs related to accessing the DW_AT_low_pc and 844 // DW_AT_high_pc. 845 const bool SupportsHighPCAsOffset = Version >= 4; 846 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 847 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 848 dwarfgen::Generator *DG = ExpectedDG.get().get(); 849 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 850 dwarfgen::DIE CUDie = CU.getUnitDIE(); 851 852 CUDie.addAttribute(DW_AT_name, DW_FORM_strp, "/tmp/main.c"); 853 CUDie.addAttribute(DW_AT_language, DW_FORM_data2, DW_LANG_C); 854 855 // Create a subprogram DIE with no low or high PC. 856 dwarfgen::DIE SubprogramNoPC = CUDie.addChild(DW_TAG_subprogram); 857 SubprogramNoPC.addAttribute(DW_AT_name, DW_FORM_strp, "no_pc"); 858 859 // Create a subprogram DIE with a low PC only. 860 dwarfgen::DIE SubprogramLowPC = CUDie.addChild(DW_TAG_subprogram); 861 SubprogramLowPC.addAttribute(DW_AT_name, DW_FORM_strp, "low_pc"); 862 const uint64_t ActualLowPC = 0x1000; 863 const uint64_t ActualHighPC = 0x2000; 864 const uint64_t ActualHighPCOffset = ActualHighPC - ActualLowPC; 865 SubprogramLowPC.addAttribute(DW_AT_low_pc, DW_FORM_addr, ActualLowPC); 866 867 // Create a subprogram DIE with a low and high PC. 868 dwarfgen::DIE SubprogramLowHighPC = CUDie.addChild(DW_TAG_subprogram); 869 SubprogramLowHighPC.addAttribute(DW_AT_name, DW_FORM_strp, "low_high_pc"); 870 SubprogramLowHighPC.addAttribute(DW_AT_low_pc, DW_FORM_addr, ActualLowPC); 871 // Encode the high PC as an offset from the low PC if supported. 872 if (SupportsHighPCAsOffset) 873 SubprogramLowHighPC.addAttribute(DW_AT_high_pc, DW_FORM_data4, 874 ActualHighPCOffset); 875 else 876 SubprogramLowHighPC.addAttribute(DW_AT_high_pc, DW_FORM_addr, ActualHighPC); 877 878 StringRef FileBytes = DG->generate(); 879 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 880 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 881 EXPECT_TRUE((bool)Obj); 882 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 883 884 // Verify the number of compile units is correct. 885 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 886 EXPECT_EQ(NumCUs, 1u); 887 DWARFCompileUnit *U = 888 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 889 890 // Get the compile unit DIE is valid. 891 auto DieDG = U->getUnitDIE(false); 892 EXPECT_TRUE(DieDG.isValid()); 893 894 uint64_t LowPC, HighPC, SectionIndex; 895 Optional<uint64_t> OptU64; 896 // Verify the that our subprogram with no PC value fails appropriately when 897 // asked for any PC values. 898 auto SubprogramDieNoPC = DieDG.getFirstChild(); 899 EXPECT_TRUE(SubprogramDieNoPC.isValid()); 900 EXPECT_EQ(SubprogramDieNoPC.getTag(), DW_TAG_subprogram); 901 OptU64 = toAddress(SubprogramDieNoPC.find(DW_AT_low_pc)); 902 EXPECT_FALSE((bool)OptU64); 903 OptU64 = toAddress(SubprogramDieNoPC.find(DW_AT_high_pc)); 904 EXPECT_FALSE((bool)OptU64); 905 EXPECT_FALSE(SubprogramDieNoPC.getLowAndHighPC(LowPC, HighPC, SectionIndex)); 906 OptU64 = toAddress(SubprogramDieNoPC.find(DW_AT_high_pc)); 907 EXPECT_FALSE((bool)OptU64); 908 OptU64 = toUnsigned(SubprogramDieNoPC.find(DW_AT_high_pc)); 909 EXPECT_FALSE((bool)OptU64); 910 OptU64 = SubprogramDieNoPC.getHighPC(ActualLowPC); 911 EXPECT_FALSE((bool)OptU64); 912 EXPECT_FALSE(SubprogramDieNoPC.getLowAndHighPC(LowPC, HighPC, SectionIndex)); 913 914 // Verify the that our subprogram with only a low PC value succeeds when 915 // we ask for the Low PC, but fails appropriately when asked for the high PC 916 // or both low and high PC values. 917 auto SubprogramDieLowPC = SubprogramDieNoPC.getSibling(); 918 EXPECT_TRUE(SubprogramDieLowPC.isValid()); 919 EXPECT_EQ(SubprogramDieLowPC.getTag(), DW_TAG_subprogram); 920 OptU64 = toAddress(SubprogramDieLowPC.find(DW_AT_low_pc)); 921 EXPECT_TRUE((bool)OptU64); 922 EXPECT_EQ(OptU64.getValue(), ActualLowPC); 923 OptU64 = toAddress(SubprogramDieLowPC.find(DW_AT_high_pc)); 924 EXPECT_FALSE((bool)OptU64); 925 OptU64 = toUnsigned(SubprogramDieLowPC.find(DW_AT_high_pc)); 926 EXPECT_FALSE((bool)OptU64); 927 OptU64 = SubprogramDieLowPC.getHighPC(ActualLowPC); 928 EXPECT_FALSE((bool)OptU64); 929 EXPECT_FALSE(SubprogramDieLowPC.getLowAndHighPC(LowPC, HighPC, SectionIndex)); 930 931 // Verify the that our subprogram with only a low PC value succeeds when 932 // we ask for the Low PC, but fails appropriately when asked for the high PC 933 // or both low and high PC values. 934 auto SubprogramDieLowHighPC = SubprogramDieLowPC.getSibling(); 935 EXPECT_TRUE(SubprogramDieLowHighPC.isValid()); 936 EXPECT_EQ(SubprogramDieLowHighPC.getTag(), DW_TAG_subprogram); 937 OptU64 = toAddress(SubprogramDieLowHighPC.find(DW_AT_low_pc)); 938 EXPECT_TRUE((bool)OptU64); 939 EXPECT_EQ(OptU64.getValue(), ActualLowPC); 940 // Get the high PC as an address. This should succeed if the high PC was 941 // encoded as an address and fail if the high PC was encoded as an offset. 942 OptU64 = toAddress(SubprogramDieLowHighPC.find(DW_AT_high_pc)); 943 if (SupportsHighPCAsOffset) { 944 EXPECT_FALSE((bool)OptU64); 945 } else { 946 EXPECT_TRUE((bool)OptU64); 947 EXPECT_EQ(OptU64.getValue(), ActualHighPC); 948 } 949 // Get the high PC as an unsigned constant. This should succeed if the high PC 950 // was encoded as an offset and fail if the high PC was encoded as an address. 951 OptU64 = toUnsigned(SubprogramDieLowHighPC.find(DW_AT_high_pc)); 952 if (SupportsHighPCAsOffset) { 953 EXPECT_TRUE((bool)OptU64); 954 EXPECT_EQ(OptU64.getValue(), ActualHighPCOffset); 955 } else { 956 EXPECT_FALSE((bool)OptU64); 957 } 958 959 OptU64 = SubprogramDieLowHighPC.getHighPC(ActualLowPC); 960 EXPECT_TRUE((bool)OptU64); 961 EXPECT_EQ(OptU64.getValue(), ActualHighPC); 962 963 EXPECT_TRUE(SubprogramDieLowHighPC.getLowAndHighPC(LowPC, HighPC, SectionIndex)); 964 EXPECT_EQ(LowPC, ActualLowPC); 965 EXPECT_EQ(HighPC, ActualHighPC); 966 } 967 968 TEST(DWARFDebugInfo, TestDWARF32Version2Addr4Addresses) { 969 // Test that we can decode address values in DWARF32, version 2, with 4 byte 970 // addresses. 971 typedef uint32_t AddrType; 972 TestAddresses<2, AddrType>(); 973 } 974 975 TEST(DWARFDebugInfo, TestDWARF32Version2Addr8Addresses) { 976 // Test that we can decode address values in DWARF32, version 2, with 8 byte 977 // addresses. 978 typedef uint64_t AddrType; 979 TestAddresses<2, AddrType>(); 980 } 981 982 TEST(DWARFDebugInfo, TestDWARF32Version3Addr4Addresses) { 983 // Test that we can decode address values in DWARF32, version 3, with 4 byte 984 // addresses. 985 typedef uint32_t AddrType; 986 TestAddresses<3, AddrType>(); 987 } 988 989 TEST(DWARFDebugInfo, TestDWARF32Version3Addr8Addresses) { 990 // Test that we can decode address values in DWARF32, version 3, with 8 byte 991 // addresses. 992 typedef uint64_t AddrType; 993 TestAddresses<3, AddrType>(); 994 } 995 996 TEST(DWARFDebugInfo, TestDWARF32Version4Addr4Addresses) { 997 // Test that we can decode address values in DWARF32, version 4, with 4 byte 998 // addresses. 999 typedef uint32_t AddrType; 1000 TestAddresses<4, AddrType>(); 1001 } 1002 1003 TEST(DWARFDebugInfo, TestDWARF32Version4Addr8Addresses) { 1004 // Test that we can decode address values in DWARF32, version 4, with 8 byte 1005 // addresses. 1006 typedef uint64_t AddrType; 1007 TestAddresses<4, AddrType>(); 1008 } 1009 1010 TEST(DWARFDebugInfo, TestStringOffsets) { 1011 Triple Triple = getNormalizedDefaultTargetTriple(); 1012 if (!isObjectEmissionSupported(Triple)) 1013 return; 1014 1015 const char *String1 = "Hello"; 1016 const char *String2 = "World"; 1017 1018 auto ExpectedDG = dwarfgen::Generator::create(Triple, 5); 1019 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1020 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1021 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1022 dwarfgen::DIE CUDie = CU.getUnitDIE(); 1023 1024 CUDie.addStrOffsetsBaseAttribute(); 1025 1026 uint16_t Attr = DW_AT_lo_user; 1027 1028 // Create our strings. First we create a non-indexed reference to String1, 1029 // followed by an indexed String2. Finally, we add an indexed reference to 1030 // String1. 1031 const auto Attr1 = static_cast<dwarf::Attribute>(Attr++); 1032 CUDie.addAttribute(Attr1, DW_FORM_strp, String1); 1033 1034 const auto Attr2 = static_cast<dwarf::Attribute>(Attr++); 1035 CUDie.addAttribute(Attr2, DW_FORM_strx, String2); 1036 1037 const auto Attr3 = static_cast<dwarf::Attribute>(Attr++); 1038 CUDie.addAttribute(Attr3, DW_FORM_strx, String1); 1039 1040 // Generate the DWARF 1041 StringRef FileBytes = DG->generate(); 1042 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 1043 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1044 ASSERT_TRUE((bool)Obj); 1045 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1046 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1047 ASSERT_EQ(NumCUs, 1u); 1048 DWARFUnit *U = DwarfContext->getUnitAtIndex(0); 1049 auto DieDG = U->getUnitDIE(false); 1050 ASSERT_TRUE(DieDG.isValid()); 1051 1052 // Now make sure the string offsets came out properly. Attr2 should have index 1053 // 0 (because it was the first indexed string) even though the string itself 1054 // was added eariler. 1055 auto Extracted1 = toString(DieDG.find(Attr1)); 1056 ASSERT_TRUE((bool)Extracted1); 1057 EXPECT_STREQ(String1, *Extracted1); 1058 1059 Optional<DWARFFormValue> Form2 = DieDG.find(Attr2); 1060 ASSERT_TRUE((bool)Form2); 1061 EXPECT_EQ(0u, Form2->getRawUValue()); 1062 auto Extracted2 = toString(Form2); 1063 ASSERT_TRUE((bool)Extracted2); 1064 EXPECT_STREQ(String2, *Extracted2); 1065 1066 Optional<DWARFFormValue> Form3 = DieDG.find(Attr3); 1067 ASSERT_TRUE((bool)Form3); 1068 EXPECT_EQ(1u, Form3->getRawUValue()); 1069 auto Extracted3 = toString(Form3); 1070 ASSERT_TRUE((bool)Extracted3); 1071 EXPECT_STREQ(String1, *Extracted3); 1072 } 1073 1074 TEST(DWARFDebugInfo, TestEmptyStringOffsets) { 1075 Triple Triple = getNormalizedDefaultTargetTriple(); 1076 if (!isObjectEmissionSupported(Triple)) 1077 return; 1078 1079 const char *String1 = "Hello"; 1080 1081 auto ExpectedDG = dwarfgen::Generator::create(Triple, 5); 1082 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1083 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1084 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1085 dwarfgen::DIE CUDie = CU.getUnitDIE(); 1086 1087 uint16_t Attr = DW_AT_lo_user; 1088 1089 // We shall insert only one string. It will be referenced directly. 1090 const auto Attr1 = static_cast<dwarf::Attribute>(Attr++); 1091 CUDie.addAttribute(Attr1, DW_FORM_strp, String1); 1092 1093 // Generate the DWARF 1094 StringRef FileBytes = DG->generate(); 1095 MemoryBufferRef FileBuffer(FileBytes, "dwarf"); 1096 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1097 ASSERT_TRUE((bool)Obj); 1098 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1099 EXPECT_TRUE( 1100 DwarfContext->getDWARFObj().getStrOffsetsSection().Data.empty()); 1101 } 1102 1103 TEST(DWARFDebugInfo, TestRelations) { 1104 Triple Triple = getNormalizedDefaultTargetTriple(); 1105 if (!isObjectEmissionSupported(Triple)) 1106 return; 1107 1108 // Test the DWARF APIs related to accessing the DW_AT_low_pc and 1109 // DW_AT_high_pc. 1110 uint16_t Version = 4; 1111 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1112 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1113 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1114 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1115 1116 enum class Tag: uint16_t { 1117 A = dwarf::DW_TAG_lo_user, 1118 B, 1119 C, 1120 C1, 1121 C2, 1122 D, 1123 D1 1124 }; 1125 1126 // Scope to allow us to re-use the same DIE names 1127 { 1128 // Create DWARF tree that looks like: 1129 // 1130 // CU 1131 // A 1132 // B 1133 // C 1134 // C1 1135 // C2 1136 // D 1137 // D1 1138 dwarfgen::DIE CUDie = CU.getUnitDIE(); 1139 dwarfgen::DIE A = CUDie.addChild((dwarf::Tag)Tag::A); 1140 A.addChild((dwarf::Tag)Tag::B); 1141 dwarfgen::DIE C = A.addChild((dwarf::Tag)Tag::C); 1142 dwarfgen::DIE D = A.addChild((dwarf::Tag)Tag::D); 1143 C.addChild((dwarf::Tag)Tag::C1); 1144 C.addChild((dwarf::Tag)Tag::C2); 1145 D.addChild((dwarf::Tag)Tag::D1); 1146 } 1147 1148 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1149 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1150 EXPECT_TRUE((bool)Obj); 1151 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1152 1153 // Verify the number of compile units is correct. 1154 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1155 EXPECT_EQ(NumCUs, 1u); 1156 DWARFCompileUnit *U = 1157 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1158 1159 // Get the compile unit DIE is valid. 1160 auto CUDie = U->getUnitDIE(false); 1161 EXPECT_TRUE(CUDie.isValid()); 1162 1163 // The compile unit doesn't have a parent or a sibling. 1164 auto ParentDie = CUDie.getParent(); 1165 EXPECT_FALSE(ParentDie.isValid()); 1166 auto SiblingDie = CUDie.getSibling(); 1167 EXPECT_FALSE(SiblingDie.isValid()); 1168 1169 // Get the children of the compile unit 1170 auto A = CUDie.getFirstChild(); 1171 auto B = A.getFirstChild(); 1172 auto C = B.getSibling(); 1173 auto D = C.getSibling(); 1174 auto Null = D.getSibling(); 1175 1176 // Verify NULL Die is NULL and has no children or siblings 1177 EXPECT_TRUE(Null.isNULL()); 1178 EXPECT_FALSE(Null.getSibling().isValid()); 1179 EXPECT_FALSE(Null.getFirstChild().isValid()); 1180 1181 // Verify all children of the compile unit DIE are correct. 1182 EXPECT_EQ(A.getTag(), (dwarf::Tag)Tag::A); 1183 EXPECT_EQ(B.getTag(), (dwarf::Tag)Tag::B); 1184 EXPECT_EQ(C.getTag(), (dwarf::Tag)Tag::C); 1185 EXPECT_EQ(D.getTag(), (dwarf::Tag)Tag::D); 1186 1187 // Verify who has children 1188 EXPECT_TRUE(A.hasChildren()); 1189 EXPECT_FALSE(B.hasChildren()); 1190 EXPECT_TRUE(C.hasChildren()); 1191 EXPECT_TRUE(D.hasChildren()); 1192 1193 // Make sure the parent of all the children of the compile unit are the 1194 // compile unit. 1195 EXPECT_EQ(A.getParent(), CUDie); 1196 1197 // Make sure the parent of all the children of A are the A. 1198 // B is the first child in A, so we need to verify we can get the previous 1199 // DIE as the parent. 1200 EXPECT_EQ(B.getParent(), A); 1201 // C is the second child in A, so we need to make sure we can backup across 1202 // other DIE (B) at the same level to get the correct parent. 1203 EXPECT_EQ(C.getParent(), A); 1204 // D is the third child of A. We need to verify we can backup across other DIE 1205 // (B and C) including DIE that have children (D) to get the correct parent. 1206 EXPECT_EQ(D.getParent(), A); 1207 1208 // Verify that a DIE with no children returns an invalid DWARFDie. 1209 EXPECT_FALSE(B.getFirstChild().isValid()); 1210 1211 // Verify the children of the B DIE 1212 auto C1 = C.getFirstChild(); 1213 auto C2 = C1.getSibling(); 1214 EXPECT_TRUE(C2.getSibling().isNULL()); 1215 1216 // Verify all children of the B DIE correctly valid or invalid. 1217 EXPECT_EQ(C1.getTag(), (dwarf::Tag)Tag::C1); 1218 EXPECT_EQ(C2.getTag(), (dwarf::Tag)Tag::C2); 1219 1220 // Make sure the parent of all the children of the B are the B. 1221 EXPECT_EQ(C1.getParent(), C); 1222 EXPECT_EQ(C2.getParent(), C); 1223 1224 // Make sure iterators work as expected. 1225 EXPECT_THAT(std::vector<DWARFDie>(A.begin(), A.end()), 1226 testing::ElementsAre(B, C, D)); 1227 EXPECT_THAT(std::vector<DWARFDie>(A.rbegin(), A.rend()), 1228 testing::ElementsAre(D, C, B)); 1229 1230 // Make sure conversion from reverse iterator works as expected. 1231 EXPECT_EQ(A.rbegin().base(), A.end()); 1232 EXPECT_EQ(A.rend().base(), A.begin()); 1233 1234 // Make sure iterator is bidirectional. 1235 { 1236 auto Begin = A.begin(); 1237 auto End = A.end(); 1238 auto It = A.begin(); 1239 1240 EXPECT_EQ(It, Begin); 1241 EXPECT_EQ(*It, B); 1242 ++It; 1243 EXPECT_EQ(*It, C); 1244 ++It; 1245 EXPECT_EQ(*It, D); 1246 ++It; 1247 EXPECT_EQ(It, End); 1248 --It; 1249 EXPECT_EQ(*It, D); 1250 --It; 1251 EXPECT_EQ(*It, C); 1252 --It; 1253 EXPECT_EQ(*It, B); 1254 EXPECT_EQ(It, Begin); 1255 } 1256 1257 // Make sure reverse iterator is bidirectional. 1258 { 1259 auto Begin = A.rbegin(); 1260 auto End = A.rend(); 1261 auto It = A.rbegin(); 1262 1263 EXPECT_EQ(It, Begin); 1264 EXPECT_EQ(*It, D); 1265 ++It; 1266 EXPECT_EQ(*It, C); 1267 ++It; 1268 EXPECT_EQ(*It, B); 1269 ++It; 1270 EXPECT_EQ(It, End); 1271 --It; 1272 EXPECT_EQ(*It, B); 1273 --It; 1274 EXPECT_EQ(*It, C); 1275 --It; 1276 EXPECT_EQ(*It, D); 1277 EXPECT_EQ(It, Begin); 1278 } 1279 } 1280 1281 TEST(DWARFDebugInfo, TestDWARFDie) { 1282 // Make sure a default constructed DWARFDie doesn't have any parent, sibling 1283 // or child; 1284 DWARFDie DefaultDie; 1285 EXPECT_FALSE(DefaultDie.getParent().isValid()); 1286 EXPECT_FALSE(DefaultDie.getFirstChild().isValid()); 1287 EXPECT_FALSE(DefaultDie.getSibling().isValid()); 1288 } 1289 1290 TEST(DWARFDebugInfo, TestChildIterators) { 1291 Triple Triple = getNormalizedDefaultTargetTriple(); 1292 if (!isObjectEmissionSupported(Triple)) 1293 return; 1294 1295 // Test the DWARF APIs related to iterating across the children of a DIE using 1296 // the DWARFDie::iterator class. 1297 uint16_t Version = 4; 1298 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1299 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1300 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1301 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1302 1303 enum class Tag: uint16_t { 1304 A = dwarf::DW_TAG_lo_user, 1305 B, 1306 }; 1307 1308 // Scope to allow us to re-use the same DIE names 1309 { 1310 // Create DWARF tree that looks like: 1311 // 1312 // CU 1313 // A 1314 // B 1315 auto CUDie = CU.getUnitDIE(); 1316 CUDie.addChild((dwarf::Tag)Tag::A); 1317 CUDie.addChild((dwarf::Tag)Tag::B); 1318 } 1319 1320 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1321 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1322 EXPECT_TRUE((bool)Obj); 1323 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1324 1325 // Verify the number of compile units is correct. 1326 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1327 EXPECT_EQ(NumCUs, 1u); 1328 DWARFCompileUnit *U = 1329 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1330 1331 // Get the compile unit DIE is valid. 1332 auto CUDie = U->getUnitDIE(false); 1333 EXPECT_TRUE(CUDie.isValid()); 1334 uint32_t Index; 1335 DWARFDie A; 1336 DWARFDie B; 1337 1338 // Verify the compile unit DIE's children. 1339 Index = 0; 1340 for (auto Die : CUDie.children()) { 1341 switch (Index++) { 1342 case 0: A = Die; break; 1343 case 1: B = Die; break; 1344 } 1345 } 1346 1347 EXPECT_EQ(A.getTag(), (dwarf::Tag)Tag::A); 1348 EXPECT_EQ(B.getTag(), (dwarf::Tag)Tag::B); 1349 1350 // Verify that A has no children by verifying that the begin and end contain 1351 // invalid DIEs and also that the iterators are equal. 1352 EXPECT_EQ(A.begin(), A.end()); 1353 } 1354 1355 TEST(DWARFDebugInfo, TestChildIteratorsOnInvalidDie) { 1356 // Verify that an invalid DIE has no children. 1357 DWARFDie Invalid; 1358 auto begin = Invalid.begin(); 1359 auto end = Invalid.end(); 1360 EXPECT_FALSE(begin->isValid()); 1361 EXPECT_FALSE(end->isValid()); 1362 EXPECT_EQ(begin, end); 1363 } 1364 1365 TEST(DWARFDebugInfo, TestEmptyChildren) { 1366 const char *yamldata = "debug_abbrev:\n" 1367 " - Table:\n" 1368 " - Code: 0x00000001\n" 1369 " Tag: DW_TAG_compile_unit\n" 1370 " Children: DW_CHILDREN_yes\n" 1371 "debug_info:\n" 1372 " - Version: 4\n" 1373 " AddrSize: 8\n" 1374 " Entries:\n" 1375 " - AbbrCode: 0x00000001\n" 1376 " - AbbrCode: 0x00000000\n"; 1377 1378 auto ErrOrSections = DWARFYAML::emitDebugSections(StringRef(yamldata)); 1379 ASSERT_TRUE((bool)ErrOrSections); 1380 std::unique_ptr<DWARFContext> DwarfContext = 1381 DWARFContext::create(*ErrOrSections, 8); 1382 1383 // Verify the number of compile units is correct. 1384 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1385 EXPECT_EQ(NumCUs, 1u); 1386 DWARFCompileUnit *U = 1387 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1388 1389 // Get the compile unit DIE is valid. 1390 auto CUDie = U->getUnitDIE(false); 1391 EXPECT_TRUE(CUDie.isValid()); 1392 1393 // Verify that the CU Die that says it has children, but doesn't, actually 1394 // has begin and end iterators that are equal. We want to make sure we don't 1395 // see the Null DIEs during iteration. 1396 EXPECT_EQ(CUDie.begin(), CUDie.end()); 1397 } 1398 1399 TEST(DWARFDebugInfo, TestAttributeIterators) { 1400 Triple Triple = getNormalizedDefaultTargetTriple(); 1401 if (!isObjectEmissionSupported(Triple)) 1402 return; 1403 1404 // Test the DWARF APIs related to iterating across all attribute values in a 1405 // a DWARFDie. 1406 uint16_t Version = 4; 1407 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1408 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1409 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1410 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1411 const uint64_t CULowPC = 0x1000; 1412 StringRef CUPath("/tmp/main.c"); 1413 1414 // Scope to allow us to re-use the same DIE names 1415 { 1416 auto CUDie = CU.getUnitDIE(); 1417 // Encode an attribute value before an attribute with no data. 1418 CUDie.addAttribute(DW_AT_name, DW_FORM_strp, CUPath.data()); 1419 // Encode an attribute value with no data in .debug_info/types to ensure 1420 // the iteration works correctly. 1421 CUDie.addAttribute(DW_AT_declaration, DW_FORM_flag_present); 1422 // Encode an attribute value after an attribute with no data. 1423 CUDie.addAttribute(DW_AT_low_pc, DW_FORM_addr, CULowPC); 1424 } 1425 1426 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1427 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1428 EXPECT_TRUE((bool)Obj); 1429 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1430 1431 // Verify the number of compile units is correct. 1432 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1433 EXPECT_EQ(NumCUs, 1u); 1434 DWARFCompileUnit *U = 1435 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1436 1437 // Get the compile unit DIE is valid. 1438 auto CUDie = U->getUnitDIE(false); 1439 EXPECT_TRUE(CUDie.isValid()); 1440 1441 auto R = CUDie.attributes(); 1442 auto I = R.begin(); 1443 auto E = R.end(); 1444 1445 ASSERT_NE(E, I); 1446 EXPECT_EQ(I->Attr, DW_AT_name); 1447 auto ActualCUPath = I->Value.getAsCString(); 1448 EXPECT_EQ(CUPath, *ActualCUPath); 1449 1450 ASSERT_NE(E, ++I); 1451 EXPECT_EQ(I->Attr, DW_AT_declaration); 1452 EXPECT_EQ(1ull, *I->Value.getAsUnsignedConstant()); 1453 1454 ASSERT_NE(E, ++I); 1455 EXPECT_EQ(I->Attr, DW_AT_low_pc); 1456 EXPECT_EQ(CULowPC, *I->Value.getAsAddress()); 1457 1458 EXPECT_EQ(E, ++I); 1459 } 1460 1461 TEST(DWARFDebugInfo, TestFindRecurse) { 1462 Triple Triple = getNormalizedDefaultTargetTriple(); 1463 if (!isObjectEmissionSupported(Triple)) 1464 return; 1465 1466 uint16_t Version = 4; 1467 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1468 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1469 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1470 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1471 1472 StringRef SpecDieName = "spec"; 1473 StringRef SpecLinkageName = "spec_linkage"; 1474 StringRef AbsDieName = "abs"; 1475 // Scope to allow us to re-use the same DIE names 1476 { 1477 auto CUDie = CU.getUnitDIE(); 1478 auto FuncSpecDie = CUDie.addChild(DW_TAG_subprogram); 1479 auto FuncAbsDie = CUDie.addChild(DW_TAG_subprogram); 1480 // Put the linkage name in a second abstract origin DIE to ensure we 1481 // recurse through more than just one DIE when looking for attributes. 1482 auto FuncAbsDie2 = CUDie.addChild(DW_TAG_subprogram); 1483 auto FuncDie = CUDie.addChild(DW_TAG_subprogram); 1484 auto VarAbsDie = CUDie.addChild(DW_TAG_variable); 1485 auto VarDie = CUDie.addChild(DW_TAG_variable); 1486 FuncSpecDie.addAttribute(DW_AT_name, DW_FORM_strp, SpecDieName); 1487 FuncAbsDie2.addAttribute(DW_AT_linkage_name, DW_FORM_strp, SpecLinkageName); 1488 FuncAbsDie.addAttribute(DW_AT_specification, DW_FORM_ref4, FuncSpecDie); 1489 FuncAbsDie.addAttribute(DW_AT_abstract_origin, DW_FORM_ref4, FuncAbsDie2); 1490 FuncDie.addAttribute(DW_AT_abstract_origin, DW_FORM_ref4, FuncAbsDie); 1491 VarAbsDie.addAttribute(DW_AT_name, DW_FORM_strp, AbsDieName); 1492 VarDie.addAttribute(DW_AT_abstract_origin, DW_FORM_ref4, VarAbsDie); 1493 } 1494 1495 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1496 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1497 EXPECT_TRUE((bool)Obj); 1498 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1499 1500 // Verify the number of compile units is correct. 1501 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1502 EXPECT_EQ(NumCUs, 1u); 1503 DWARFCompileUnit *U = 1504 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1505 1506 // Get the compile unit DIE is valid. 1507 auto CUDie = U->getUnitDIE(false); 1508 EXPECT_TRUE(CUDie.isValid()); 1509 1510 auto FuncSpecDie = CUDie.getFirstChild(); 1511 auto FuncAbsDie = FuncSpecDie.getSibling(); 1512 auto FuncAbsDie2 = FuncAbsDie.getSibling(); 1513 auto FuncDie = FuncAbsDie2.getSibling(); 1514 auto VarAbsDie = FuncDie.getSibling(); 1515 auto VarDie = VarAbsDie.getSibling(); 1516 1517 // Make sure we can't extract the name from the specification die when using 1518 // DWARFDie::find() since it won't check the DW_AT_specification DIE. 1519 EXPECT_FALSE(FuncDie.find(DW_AT_name)); 1520 1521 // Make sure we can extract the name from the specification die when using 1522 // DWARFDie::findRecursively() since it should recurse through the 1523 // DW_AT_specification DIE. 1524 auto NameOpt = FuncDie.findRecursively(DW_AT_name); 1525 EXPECT_TRUE(NameOpt); 1526 // Test the dwarf::toString() helper function. 1527 auto StringOpt = toString(NameOpt); 1528 EXPECT_TRUE(StringOpt); 1529 EXPECT_EQ(SpecDieName, StringOpt.getValueOr(nullptr)); 1530 // Test the dwarf::toString() helper function with a default value specified. 1531 EXPECT_EQ(SpecDieName, toString(NameOpt, nullptr)); 1532 1533 auto LinkageNameOpt = FuncDie.findRecursively(DW_AT_linkage_name); 1534 EXPECT_EQ(SpecLinkageName, toString(LinkageNameOpt).getValueOr(nullptr)); 1535 1536 // Make sure we can't extract the name from the abstract origin die when using 1537 // DWARFDie::find() since it won't check the DW_AT_abstract_origin DIE. 1538 EXPECT_FALSE(VarDie.find(DW_AT_name)); 1539 1540 // Make sure we can extract the name from the abstract origin die when using 1541 // DWARFDie::findRecursively() since it should recurse through the 1542 // DW_AT_abstract_origin DIE. 1543 NameOpt = VarDie.findRecursively(DW_AT_name); 1544 EXPECT_TRUE(NameOpt); 1545 // Test the dwarf::toString() helper function. 1546 StringOpt = toString(NameOpt); 1547 EXPECT_TRUE(StringOpt); 1548 EXPECT_EQ(AbsDieName, StringOpt.getValueOr(nullptr)); 1549 } 1550 1551 TEST(DWARFDebugInfo, TestDwarfToFunctions) { 1552 // Test all of the dwarf::toXXX functions that take a 1553 // Optional<DWARFFormValue> and extract the values from it. 1554 uint64_t InvalidU64 = 0xBADBADBADBADBADB; 1555 int64_t InvalidS64 = 0xBADBADBADBADBADB; 1556 1557 // First test that we don't get valid values back when using an optional with 1558 // no value. 1559 Optional<DWARFFormValue> FormValOpt1 = DWARFFormValue(); 1560 EXPECT_FALSE(toString(FormValOpt1).hasValue()); 1561 EXPECT_FALSE(toUnsigned(FormValOpt1).hasValue()); 1562 EXPECT_FALSE(toReference(FormValOpt1).hasValue()); 1563 EXPECT_FALSE(toSigned(FormValOpt1).hasValue()); 1564 EXPECT_FALSE(toAddress(FormValOpt1).hasValue()); 1565 EXPECT_FALSE(toSectionOffset(FormValOpt1).hasValue()); 1566 EXPECT_FALSE(toBlock(FormValOpt1).hasValue()); 1567 EXPECT_EQ(nullptr, toString(FormValOpt1, nullptr)); 1568 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt1, InvalidU64)); 1569 EXPECT_EQ(InvalidU64, toReference(FormValOpt1, InvalidU64)); 1570 EXPECT_EQ(InvalidU64, toAddress(FormValOpt1, InvalidU64)); 1571 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt1, InvalidU64)); 1572 EXPECT_EQ(InvalidS64, toSigned(FormValOpt1, InvalidS64)); 1573 1574 // Test successful and unsuccessful address decoding. 1575 uint64_t Address = 0x100000000ULL; 1576 Optional<DWARFFormValue> FormValOpt2 = 1577 DWARFFormValue::createFromUValue(DW_FORM_addr, Address); 1578 1579 EXPECT_FALSE(toString(FormValOpt2).hasValue()); 1580 EXPECT_FALSE(toUnsigned(FormValOpt2).hasValue()); 1581 EXPECT_FALSE(toReference(FormValOpt2).hasValue()); 1582 EXPECT_FALSE(toSigned(FormValOpt2).hasValue()); 1583 EXPECT_TRUE(toAddress(FormValOpt2).hasValue()); 1584 EXPECT_FALSE(toSectionOffset(FormValOpt2).hasValue()); 1585 EXPECT_FALSE(toBlock(FormValOpt2).hasValue()); 1586 EXPECT_EQ(nullptr, toString(FormValOpt2, nullptr)); 1587 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt2, InvalidU64)); 1588 EXPECT_EQ(InvalidU64, toReference(FormValOpt2, InvalidU64)); 1589 EXPECT_EQ(Address, toAddress(FormValOpt2, InvalidU64)); 1590 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt2, InvalidU64)); 1591 EXPECT_EQ(InvalidS64, toSigned(FormValOpt2, InvalidU64)); 1592 1593 // Test successful and unsuccessful unsigned constant decoding. 1594 uint64_t UData8 = 0x1020304050607080ULL; 1595 Optional<DWARFFormValue> FormValOpt3 = 1596 DWARFFormValue::createFromUValue(DW_FORM_udata, UData8); 1597 1598 EXPECT_FALSE(toString(FormValOpt3).hasValue()); 1599 EXPECT_TRUE(toUnsigned(FormValOpt3).hasValue()); 1600 EXPECT_FALSE(toReference(FormValOpt3).hasValue()); 1601 EXPECT_TRUE(toSigned(FormValOpt3).hasValue()); 1602 EXPECT_FALSE(toAddress(FormValOpt3).hasValue()); 1603 EXPECT_FALSE(toSectionOffset(FormValOpt3).hasValue()); 1604 EXPECT_FALSE(toBlock(FormValOpt3).hasValue()); 1605 EXPECT_EQ(nullptr, toString(FormValOpt3, nullptr)); 1606 EXPECT_EQ(UData8, toUnsigned(FormValOpt3, InvalidU64)); 1607 EXPECT_EQ(InvalidU64, toReference(FormValOpt3, InvalidU64)); 1608 EXPECT_EQ(InvalidU64, toAddress(FormValOpt3, InvalidU64)); 1609 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt3, InvalidU64)); 1610 EXPECT_EQ((int64_t)UData8, toSigned(FormValOpt3, InvalidU64)); 1611 1612 // Test successful and unsuccessful reference decoding. 1613 uint32_t RefData = 0x11223344U; 1614 Optional<DWARFFormValue> FormValOpt4 = 1615 DWARFFormValue::createFromUValue(DW_FORM_ref_addr, RefData); 1616 1617 EXPECT_FALSE(toString(FormValOpt4).hasValue()); 1618 EXPECT_FALSE(toUnsigned(FormValOpt4).hasValue()); 1619 EXPECT_TRUE(toReference(FormValOpt4).hasValue()); 1620 EXPECT_FALSE(toSigned(FormValOpt4).hasValue()); 1621 EXPECT_FALSE(toAddress(FormValOpt4).hasValue()); 1622 EXPECT_FALSE(toSectionOffset(FormValOpt4).hasValue()); 1623 EXPECT_FALSE(toBlock(FormValOpt4).hasValue()); 1624 EXPECT_EQ(nullptr, toString(FormValOpt4, nullptr)); 1625 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt4, InvalidU64)); 1626 EXPECT_EQ(RefData, toReference(FormValOpt4, InvalidU64)); 1627 EXPECT_EQ(InvalidU64, toAddress(FormValOpt4, InvalidU64)); 1628 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt4, InvalidU64)); 1629 EXPECT_EQ(InvalidS64, toSigned(FormValOpt4, InvalidU64)); 1630 1631 // Test successful and unsuccessful signed constant decoding. 1632 int64_t SData8 = 0x1020304050607080ULL; 1633 Optional<DWARFFormValue> FormValOpt5 = 1634 DWARFFormValue::createFromSValue(DW_FORM_udata, SData8); 1635 1636 EXPECT_FALSE(toString(FormValOpt5).hasValue()); 1637 EXPECT_TRUE(toUnsigned(FormValOpt5).hasValue()); 1638 EXPECT_FALSE(toReference(FormValOpt5).hasValue()); 1639 EXPECT_TRUE(toSigned(FormValOpt5).hasValue()); 1640 EXPECT_FALSE(toAddress(FormValOpt5).hasValue()); 1641 EXPECT_FALSE(toSectionOffset(FormValOpt5).hasValue()); 1642 EXPECT_FALSE(toBlock(FormValOpt5).hasValue()); 1643 EXPECT_EQ(nullptr, toString(FormValOpt5, nullptr)); 1644 EXPECT_EQ((uint64_t)SData8, toUnsigned(FormValOpt5, InvalidU64)); 1645 EXPECT_EQ(InvalidU64, toReference(FormValOpt5, InvalidU64)); 1646 EXPECT_EQ(InvalidU64, toAddress(FormValOpt5, InvalidU64)); 1647 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt5, InvalidU64)); 1648 EXPECT_EQ(SData8, toSigned(FormValOpt5, InvalidU64)); 1649 1650 // Test successful and unsuccessful block decoding. 1651 uint8_t Data[] = { 2, 3, 4 }; 1652 ArrayRef<uint8_t> Array(Data); 1653 Optional<DWARFFormValue> FormValOpt6 = 1654 DWARFFormValue::createFromBlockValue(DW_FORM_block1, Array); 1655 1656 EXPECT_FALSE(toString(FormValOpt6).hasValue()); 1657 EXPECT_FALSE(toUnsigned(FormValOpt6).hasValue()); 1658 EXPECT_FALSE(toReference(FormValOpt6).hasValue()); 1659 EXPECT_FALSE(toSigned(FormValOpt6).hasValue()); 1660 EXPECT_FALSE(toAddress(FormValOpt6).hasValue()); 1661 EXPECT_FALSE(toSectionOffset(FormValOpt6).hasValue()); 1662 auto BlockOpt = toBlock(FormValOpt6); 1663 EXPECT_TRUE(BlockOpt.hasValue()); 1664 EXPECT_EQ(*BlockOpt, Array); 1665 EXPECT_EQ(nullptr, toString(FormValOpt6, nullptr)); 1666 EXPECT_EQ(InvalidU64, toUnsigned(FormValOpt6, InvalidU64)); 1667 EXPECT_EQ(InvalidU64, toReference(FormValOpt6, InvalidU64)); 1668 EXPECT_EQ(InvalidU64, toAddress(FormValOpt6, InvalidU64)); 1669 EXPECT_EQ(InvalidU64, toSectionOffset(FormValOpt6, InvalidU64)); 1670 EXPECT_EQ(InvalidS64, toSigned(FormValOpt6, InvalidU64)); 1671 1672 // Test 1673 } 1674 1675 TEST(DWARFDebugInfo, TestFindAttrs) { 1676 Triple Triple = getNormalizedDefaultTargetTriple(); 1677 if (!isObjectEmissionSupported(Triple)) 1678 return; 1679 1680 // Test the DWARFDie::find() and DWARFDie::findRecursively() that take an 1681 // ArrayRef<dwarf::Attribute> value to make sure they work correctly. 1682 uint16_t Version = 4; 1683 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1684 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1685 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1686 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1687 1688 StringRef DieMangled("_Z3fooi"); 1689 // Scope to allow us to re-use the same DIE names 1690 { 1691 auto CUDie = CU.getUnitDIE(); 1692 auto FuncSpecDie = CUDie.addChild(DW_TAG_subprogram); 1693 auto FuncDie = CUDie.addChild(DW_TAG_subprogram); 1694 FuncSpecDie.addAttribute(DW_AT_MIPS_linkage_name, DW_FORM_strp, DieMangled); 1695 FuncDie.addAttribute(DW_AT_specification, DW_FORM_ref4, FuncSpecDie); 1696 } 1697 1698 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1699 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1700 EXPECT_TRUE((bool)Obj); 1701 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1702 1703 // Verify the number of compile units is correct. 1704 uint32_t NumCUs = DwarfContext->getNumCompileUnits(); 1705 EXPECT_EQ(NumCUs, 1u); 1706 DWARFCompileUnit *U = 1707 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1708 1709 // Get the compile unit DIE is valid. 1710 auto CUDie = U->getUnitDIE(false); 1711 EXPECT_TRUE(CUDie.isValid()); 1712 1713 auto FuncSpecDie = CUDie.getFirstChild(); 1714 auto FuncDie = FuncSpecDie.getSibling(); 1715 1716 // Make sure that passing in an empty attribute list behave correctly. 1717 EXPECT_FALSE(FuncDie.find(ArrayRef<dwarf::Attribute>()).hasValue()); 1718 1719 // Make sure that passing in a list of attribute that are not contained 1720 // in the DIE returns nothing. 1721 EXPECT_FALSE(FuncDie.find({DW_AT_low_pc, DW_AT_entry_pc}).hasValue()); 1722 1723 const dwarf::Attribute Attrs[] = {DW_AT_linkage_name, 1724 DW_AT_MIPS_linkage_name}; 1725 1726 // Make sure we can't extract the linkage name attributes when using 1727 // DWARFDie::find() since it won't check the DW_AT_specification DIE. 1728 EXPECT_FALSE(FuncDie.find(Attrs).hasValue()); 1729 1730 // Make sure we can extract the name from the specification die when using 1731 // DWARFDie::findRecursively() since it should recurse through the 1732 // DW_AT_specification DIE. 1733 auto NameOpt = FuncDie.findRecursively(Attrs); 1734 EXPECT_TRUE(NameOpt.hasValue()); 1735 EXPECT_EQ(DieMangled, toString(NameOpt, "")); 1736 } 1737 1738 TEST(DWARFDebugInfo, TestImplicitConstAbbrevs) { 1739 Triple Triple = getNormalizedDefaultTargetTriple(); 1740 if (!isObjectEmissionSupported(Triple)) 1741 return; 1742 1743 uint16_t Version = 5; 1744 auto ExpectedDG = dwarfgen::Generator::create(Triple, Version); 1745 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1746 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1747 dwarfgen::CompileUnit &CU = DG->addCompileUnit(); 1748 dwarfgen::DIE CUDie = CU.getUnitDIE(); 1749 const dwarf::Attribute Attr = DW_AT_lo_user; 1750 const int64_t Val1 = 42; 1751 const int64_t Val2 = 43; 1752 1753 auto FirstVal1DIE = CUDie.addChild(DW_TAG_class_type); 1754 FirstVal1DIE.addAttribute(Attr, DW_FORM_implicit_const, Val1); 1755 1756 auto SecondVal1DIE = CUDie.addChild(DW_TAG_class_type); 1757 SecondVal1DIE.addAttribute(Attr, DW_FORM_implicit_const, Val1); 1758 1759 auto Val2DIE = CUDie.addChild(DW_TAG_class_type); 1760 Val2DIE.addAttribute(Attr, DW_FORM_implicit_const, Val2); 1761 1762 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1763 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1764 EXPECT_TRUE((bool)Obj); 1765 std::unique_ptr<DWARFContext> DwarfContext = DWARFContext::create(**Obj); 1766 DWARFCompileUnit *U = 1767 cast<DWARFCompileUnit>(DwarfContext->getUnitAtIndex(0)); 1768 EXPECT_TRUE((bool)U); 1769 1770 const auto *Abbrevs = U->getAbbreviations(); 1771 EXPECT_TRUE((bool)Abbrevs); 1772 1773 // Let's find implicit_const abbrevs and verify, 1774 // that there are exactly two of them and both of them 1775 // can be dumped correctly. 1776 typedef decltype(Abbrevs->begin()) AbbrevIt; 1777 AbbrevIt Val1Abbrev = Abbrevs->end(); 1778 AbbrevIt Val2Abbrev = Abbrevs->end(); 1779 for(auto it = Abbrevs->begin(); it != Abbrevs->end(); ++it) { 1780 if (it->getNumAttributes() == 0) 1781 continue; // root abbrev for DW_TAG_compile_unit 1782 1783 auto A = it->getAttrByIndex(0); 1784 EXPECT_EQ(A, Attr); 1785 1786 auto FormValue = it->getAttributeValue(/* offset */ 0, A, *U); 1787 EXPECT_TRUE((bool)FormValue); 1788 EXPECT_EQ(FormValue->getForm(), dwarf::DW_FORM_implicit_const); 1789 1790 const auto V = FormValue->getAsSignedConstant(); 1791 EXPECT_TRUE((bool)V); 1792 1793 auto VerifyAbbrevDump = [&V](AbbrevIt it) { 1794 std::string S; 1795 llvm::raw_string_ostream OS(S); 1796 it->dump(OS); 1797 auto FormPos = OS.str().find("DW_FORM_implicit_const"); 1798 EXPECT_NE(FormPos, std::string::npos); 1799 auto ValPos = S.find_first_of("-0123456789", FormPos); 1800 EXPECT_NE(ValPos, std::string::npos); 1801 int64_t Val = std::atoll(S.substr(ValPos).c_str()); 1802 EXPECT_EQ(Val, *V); 1803 }; 1804 1805 switch(*V) { 1806 case Val1: 1807 EXPECT_EQ(Val1Abbrev, Abbrevs->end()); 1808 Val1Abbrev = it; 1809 VerifyAbbrevDump(it); 1810 break; 1811 case Val2: 1812 EXPECT_EQ(Val2Abbrev, Abbrevs->end()); 1813 Val2Abbrev = it; 1814 VerifyAbbrevDump(it); 1815 break; 1816 default: 1817 FAIL() << "Unexpected attribute value: " << *V; 1818 } 1819 } 1820 1821 // Now let's make sure that two Val1-DIEs refer to the same abbrev, 1822 // and Val2-DIE refers to another one. 1823 auto DieDG = U->getUnitDIE(false); 1824 auto it = DieDG.begin(); 1825 std::multimap<int64_t, decltype(it->getAbbreviationDeclarationPtr())> DIEs; 1826 const DWARFAbbreviationDeclaration *AbbrevPtrVal1 = nullptr; 1827 const DWARFAbbreviationDeclaration *AbbrevPtrVal2 = nullptr; 1828 for (; it != DieDG.end(); ++it) { 1829 const auto *AbbrevPtr = it->getAbbreviationDeclarationPtr(); 1830 EXPECT_TRUE((bool)AbbrevPtr); 1831 auto FormValue = it->find(Attr); 1832 EXPECT_TRUE((bool)FormValue); 1833 const auto V = FormValue->getAsSignedConstant(); 1834 EXPECT_TRUE((bool)V); 1835 switch(*V) { 1836 case Val1: 1837 AbbrevPtrVal1 = AbbrevPtr; 1838 break; 1839 case Val2: 1840 AbbrevPtrVal2 = AbbrevPtr; 1841 break; 1842 default: 1843 FAIL() << "Unexpected attribute value: " << *V; 1844 } 1845 DIEs.insert(std::make_pair(*V, AbbrevPtr)); 1846 } 1847 EXPECT_EQ(DIEs.count(Val1), 2u); 1848 EXPECT_EQ(DIEs.count(Val2), 1u); 1849 auto Val1Range = DIEs.equal_range(Val1); 1850 for (auto it = Val1Range.first; it != Val1Range.second; ++it) 1851 EXPECT_EQ(it->second, AbbrevPtrVal1); 1852 EXPECT_EQ(DIEs.find(Val2)->second, AbbrevPtrVal2); 1853 } 1854 1855 TEST(DWARFDebugInfo, TestErrorReporting) { 1856 Triple Triple("x86_64-pc-linux"); 1857 if (!isConfigurationSupported(Triple)) 1858 return; 1859 1860 auto ExpectedDG = dwarfgen::Generator::create(Triple, 4 /*DwarfVersion*/); 1861 ASSERT_THAT_EXPECTED(ExpectedDG, Succeeded()); 1862 dwarfgen::Generator *DG = ExpectedDG.get().get(); 1863 AsmPrinter *AP = DG->getAsmPrinter(); 1864 MCContext *MC = DG->getMCContext(); 1865 1866 // Emit two compressed sections with broken headers. 1867 AP->OutStreamer->SwitchSection( 1868 MC->getELFSection(".zdebug_foo", 0 /*Type*/, 0 /*Flags*/)); 1869 AP->OutStreamer->emitBytes("0"); 1870 AP->OutStreamer->SwitchSection( 1871 MC->getELFSection(".zdebug_bar", 0 /*Type*/, 0 /*Flags*/)); 1872 AP->OutStreamer->emitBytes("0"); 1873 1874 MemoryBufferRef FileBuffer(DG->generate(), "dwarf"); 1875 auto Obj = object::ObjectFile::createObjectFile(FileBuffer); 1876 EXPECT_TRUE((bool)Obj); 1877 1878 // DWARFContext parses whole file and finds the two errors we expect. 1879 int Errors = 0; 1880 std::unique_ptr<DWARFContext> Ctx1 = DWARFContext::create( 1881 **Obj, DWARFContext::ProcessDebugRelocations::Process, nullptr, "", 1882 [&](Error E) { 1883 ++Errors; 1884 consumeError(std::move(E)); 1885 }); 1886 EXPECT_TRUE(Errors == 2); 1887 } 1888 1889 TEST(DWARFDebugInfo, TestDWARFDieRangeInfoContains) { 1890 DWARFVerifier::DieRangeInfo Empty; 1891 ASSERT_TRUE(Empty.contains(Empty)); 1892 1893 DWARFVerifier::DieRangeInfo Ranges( 1894 {{0x10, 0x20}, {0x30, 0x40}, {0x40, 0x50}}); 1895 1896 ASSERT_TRUE(Ranges.contains(Empty)); 1897 ASSERT_FALSE(Ranges.contains({{{0x0f, 0x10}}})); 1898 ASSERT_FALSE(Ranges.contains({{{0x0f, 0x20}}})); 1899 ASSERT_FALSE(Ranges.contains({{{0x0f, 0x21}}})); 1900 1901 // Test ranges that start at R's start address 1902 ASSERT_TRUE(Ranges.contains({{{0x10, 0x10}}})); 1903 ASSERT_TRUE(Ranges.contains({{{0x10, 0x11}}})); 1904 ASSERT_TRUE(Ranges.contains({{{0x10, 0x20}}})); 1905 ASSERT_FALSE(Ranges.contains({{{0x10, 0x21}}})); 1906 1907 ASSERT_TRUE(Ranges.contains({{{0x11, 0x12}}})); 1908 1909 // Test ranges that start at last bytes of Range 1910 ASSERT_TRUE(Ranges.contains({{{0x1f, 0x20}}})); 1911 ASSERT_FALSE(Ranges.contains({{{0x1f, 0x21}}})); 1912 1913 // Test ranges that start after Range 1914 ASSERT_TRUE(Ranges.contains({{{0x20, 0x20}}})); 1915 ASSERT_FALSE(Ranges.contains({{{0x20, 0x21}}})); 1916 1917 ASSERT_TRUE(Ranges.contains({{{0x31, 0x32}}})); 1918 ASSERT_TRUE(Ranges.contains({{{0x3f, 0x40}}})); 1919 ASSERT_TRUE(Ranges.contains({{{0x10, 0x20}, {0x30, 0x40}}})); 1920 ASSERT_TRUE(Ranges.contains({{{0x11, 0x12}, {0x31, 0x32}}})); 1921 ASSERT_TRUE(Ranges.contains( 1922 {{{0x11, 0x12}, {0x12, 0x13}, {0x31, 0x32}, {0x32, 0x33}}})); 1923 ASSERT_FALSE(Ranges.contains({{{0x11, 0x12}, 1924 {0x12, 0x13}, 1925 {0x20, 0x21}, 1926 {0x31, 0x32}, 1927 {0x32, 0x33}}})); 1928 ASSERT_FALSE(Ranges.contains( 1929 {{{0x11, 0x12}, {0x12, 0x13}, {0x31, 0x32}, {0x32, 0x51}}})); 1930 ASSERT_TRUE(Ranges.contains({{{0x11, 0x12}, {0x30, 0x50}}})); 1931 ASSERT_FALSE(Ranges.contains({{{0x30, 0x51}}})); 1932 ASSERT_FALSE(Ranges.contains({{{0x50, 0x51}}})); 1933 } 1934 1935 namespace { 1936 1937 void AssertRangesIntersect(const DWARFAddressRange &LHS, 1938 const DWARFAddressRange &RHS) { 1939 ASSERT_TRUE(LHS.intersects(RHS)); 1940 ASSERT_TRUE(RHS.intersects(LHS)); 1941 } 1942 void AssertRangesDontIntersect(const DWARFAddressRange &LHS, 1943 const DWARFAddressRange &RHS) { 1944 ASSERT_FALSE(LHS.intersects(RHS)); 1945 ASSERT_FALSE(RHS.intersects(LHS)); 1946 } 1947 1948 void AssertRangesIntersect(const DWARFVerifier::DieRangeInfo &LHS, 1949 const DWARFAddressRangesVector &Ranges) { 1950 DWARFVerifier::DieRangeInfo RHS(Ranges); 1951 ASSERT_TRUE(LHS.intersects(RHS)); 1952 ASSERT_TRUE(RHS.intersects(LHS)); 1953 } 1954 1955 void AssertRangesDontIntersect(const DWARFVerifier::DieRangeInfo &LHS, 1956 const DWARFAddressRangesVector &Ranges) { 1957 DWARFVerifier::DieRangeInfo RHS(Ranges); 1958 ASSERT_FALSE(LHS.intersects(RHS)); 1959 ASSERT_FALSE(RHS.intersects(LHS)); 1960 } 1961 1962 } // namespace 1963 TEST(DWARFDebugInfo, TestDwarfRangesIntersect) { 1964 DWARFAddressRange R(0x10, 0x20); 1965 1966 //---------------------------------------------------------------------- 1967 // Test ranges that start before R... 1968 //---------------------------------------------------------------------- 1969 // Other range ends before start of R 1970 AssertRangesDontIntersect(R, {0x00, 0x10}); 1971 // Other range end address is start of a R 1972 AssertRangesIntersect(R, {0x00, 0x11}); 1973 // Other range end address is in R 1974 AssertRangesIntersect(R, {0x00, 0x15}); 1975 // Other range end address is at and of R 1976 AssertRangesIntersect(R, {0x00, 0x20}); 1977 // Other range end address is past end of R 1978 AssertRangesIntersect(R, {0x00, 0x40}); 1979 1980 //---------------------------------------------------------------------- 1981 // Test ranges that start at R's start address 1982 //---------------------------------------------------------------------- 1983 // Ensure empty ranges doesn't match 1984 AssertRangesDontIntersect(R, {0x10, 0x10}); 1985 // 1 byte of Range 1986 AssertRangesIntersect(R, {0x10, 0x11}); 1987 // same as Range 1988 AssertRangesIntersect(R, {0x10, 0x20}); 1989 // 1 byte past Range 1990 AssertRangesIntersect(R, {0x10, 0x21}); 1991 1992 //---------------------------------------------------------------------- 1993 // Test ranges that start inside Range 1994 //---------------------------------------------------------------------- 1995 // empty in range 1996 AssertRangesDontIntersect(R, {0x11, 0x11}); 1997 // all in Range 1998 AssertRangesIntersect(R, {0x11, 0x1f}); 1999 // ends at end of Range 2000 AssertRangesIntersect(R, {0x11, 0x20}); 2001 // ends past Range 2002 AssertRangesIntersect(R, {0x11, 0x21}); 2003 2004 //---------------------------------------------------------------------- 2005 // Test ranges that start at last bytes of Range 2006 //---------------------------------------------------------------------- 2007 // ends at end of Range 2008 AssertRangesIntersect(R, {0x1f, 0x20}); 2009 // ends past Range 2010 AssertRangesIntersect(R, {0x1f, 0x21}); 2011 2012 //---------------------------------------------------------------------- 2013 // Test ranges that start after Range 2014 //---------------------------------------------------------------------- 2015 // empty just past in Range 2016 AssertRangesDontIntersect(R, {0x20, 0x20}); 2017 // valid past Range 2018 AssertRangesDontIntersect(R, {0x20, 0x21}); 2019 } 2020 2021 TEST(DWARFDebugInfo, TestDWARFDieRangeInfoIntersects) { 2022 2023 DWARFVerifier::DieRangeInfo Ranges({{0x10, 0x20}, {0x30, 0x40}}); 2024 2025 // Test empty range 2026 AssertRangesDontIntersect(Ranges, {}); 2027 // Test range that appears before all ranges in Ranges 2028 AssertRangesDontIntersect(Ranges, {{0x00, 0x10}}); 2029 // Test range that appears between ranges in Ranges 2030 AssertRangesDontIntersect(Ranges, {{0x20, 0x30}}); 2031 // Test range that appears after ranges in Ranges 2032 AssertRangesDontIntersect(Ranges, {{0x40, 0x50}}); 2033 2034 // Test range that start before first range 2035 AssertRangesIntersect(Ranges, {{0x00, 0x11}}); 2036 // Test range that start at first range 2037 AssertRangesIntersect(Ranges, {{0x10, 0x11}}); 2038 // Test range that start in first range 2039 AssertRangesIntersect(Ranges, {{0x11, 0x12}}); 2040 // Test range that start at end of first range 2041 AssertRangesIntersect(Ranges, {{0x1f, 0x20}}); 2042 // Test range that starts at end of first range 2043 AssertRangesDontIntersect(Ranges, {{0x20, 0x21}}); 2044 // Test range that starts at end of first range 2045 AssertRangesIntersect(Ranges, {{0x20, 0x31}}); 2046 2047 // Test range that start before second range and ends before second 2048 AssertRangesDontIntersect(Ranges, {{0x2f, 0x30}}); 2049 // Test range that start before second range and ends in second 2050 AssertRangesIntersect(Ranges, {{0x2f, 0x31}}); 2051 // Test range that start at second range 2052 AssertRangesIntersect(Ranges, {{0x30, 0x31}}); 2053 // Test range that start in second range 2054 AssertRangesIntersect(Ranges, {{0x31, 0x32}}); 2055 // Test range that start at end of second range 2056 AssertRangesIntersect(Ranges, {{0x3f, 0x40}}); 2057 // Test range that starts at end of second range 2058 AssertRangesDontIntersect(Ranges, {{0x40, 0x41}}); 2059 2060 AssertRangesDontIntersect(Ranges, {{0x20, 0x21}, {0x2f, 0x30}}); 2061 AssertRangesIntersect(Ranges, {{0x20, 0x21}, {0x2f, 0x31}}); 2062 } 2063 2064 TEST(DWARFDebugInfo, TestDWARF64UnitLength) { 2065 static const char DebugInfoSecRaw[] = 2066 "\xff\xff\xff\xff" // DWARF64 mark 2067 "\x88\x77\x66\x55\x44\x33\x22\x11" // Length 2068 "\x05\x00" // Version 2069 "\x01" // DW_UT_compile 2070 "\x04" // Address size 2071 "\0\0\0\0\0\0\0\0"; // Offset Into Abbrev. Sec. 2072 StringMap<std::unique_ptr<MemoryBuffer>> Sections; 2073 Sections.insert(std::make_pair( 2074 "debug_info", MemoryBuffer::getMemBuffer(StringRef( 2075 DebugInfoSecRaw, sizeof(DebugInfoSecRaw) - 1)))); 2076 auto Context = DWARFContext::create(Sections, /* AddrSize = */ 4, 2077 /* isLittleEndian = */ true); 2078 const auto &Obj = Context->getDWARFObj(); 2079 Obj.forEachInfoSections([&](const DWARFSection &Sec) { 2080 DWARFUnitHeader Header; 2081 DWARFDataExtractor Data(Obj, Sec, /* IsLittleEndian = */ true, 2082 /* AddressSize = */ 4); 2083 uint64_t Offset = 0; 2084 EXPECT_FALSE(Header.extract(*Context, Data, &Offset, DW_SECT_INFO)); 2085 // Header.extract() returns false because there is not enough space 2086 // in the section for the declared length. Anyway, we can check that 2087 // the properties are read correctly. 2088 ASSERT_EQ(DwarfFormat::DWARF64, Header.getFormat()); 2089 ASSERT_EQ(0x1122334455667788ULL, Header.getLength()); 2090 ASSERT_EQ(5, Header.getVersion()); 2091 ASSERT_EQ(DW_UT_compile, Header.getUnitType()); 2092 ASSERT_EQ(4, Header.getAddressByteSize()); 2093 2094 // Check that the length can be correctly read in the unit class. 2095 DWARFUnitVector DummyUnitVector; 2096 DWARFSection DummySec; 2097 DWARFCompileUnit CU(*Context, Sec, Header, /* DA = */ 0, /* RS = */ 0, 2098 /* LocSection = */ 0, /* SS = */ StringRef(), 2099 /* SOS = */ DummySec, /* AOS = */ 0, 2100 /* LS = */ DummySec, /* LE = */ true, 2101 /* isDWO= */ false, DummyUnitVector); 2102 ASSERT_EQ(0x1122334455667788ULL, CU.getLength()); 2103 }); 2104 } 2105 2106 } // end anonymous namespace 2107