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