mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-25 04:02:41 +01:00
197838dd0c
Summary: We have had at least three pieces of code (in DWARFAbbreviationDeclaration, DWARFAcceleratorTable and DWARFDie) that have hand-rolled support for dumping unknown dwarf enum values. While not terrible, they are a bit distracting and enable small differences to creep in (Unknown_ffff vs. Unknown_0xffff). I ended up needing to add a fourth place (DWARFVerifier), so it seems it would be a good time to centralize. This patch creates an alternative to the XXXString dumping functions in the BinaryFormat library, which formats an unknown value as DW_TYPE_unknown_1234, instead of just an empty string. It is based on the formatv function, as that allows us to avoid materializing the string for unknown values (and because this way I don't have to invent a name for the new functions :P). In this patch I add formatters for dwarf attributes, forms, tags, and index attributes as these are the ones in use currently, but adding other enums is straight-forward. Reviewers: dblaikie, JDevlieghere, aprantl Subscribers: llvm-commits Differential Revision: https://reviews.llvm.org/D44570 llvm-svn: 328090
207 lines
7.7 KiB
C++
207 lines
7.7 KiB
C++
//===- unittest/BinaryFormat/DwarfTest.cpp - Dwarf support tests ----------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/BinaryFormat/Dwarf.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/FormatVariadic.h"
|
|
#include "gtest/gtest.h"
|
|
|
|
using namespace llvm;
|
|
using namespace llvm::dwarf;
|
|
|
|
namespace {
|
|
|
|
TEST(DwarfTest, TagStringOnInvalid) {
|
|
// This is invalid, so it shouldn't be stringified.
|
|
EXPECT_EQ(StringRef(), TagString(DW_TAG_invalid));
|
|
|
|
// These aren't really tags: they describe ranges within tags. They
|
|
// shouldn't be stringified either.
|
|
EXPECT_EQ(StringRef(), TagString(DW_TAG_lo_user));
|
|
EXPECT_EQ(StringRef(), TagString(DW_TAG_hi_user));
|
|
EXPECT_EQ(StringRef(), TagString(DW_TAG_user_base));
|
|
}
|
|
|
|
TEST(DwarfTest, getTag) {
|
|
// A couple of valid tags.
|
|
EXPECT_EQ(DW_TAG_array_type, getTag("DW_TAG_array_type"));
|
|
EXPECT_EQ(DW_TAG_module, getTag("DW_TAG_module"));
|
|
|
|
// Invalid tags.
|
|
EXPECT_EQ(DW_TAG_invalid, getTag("DW_TAG_invalid"));
|
|
EXPECT_EQ(DW_TAG_invalid, getTag("DW_TAG_madeuptag"));
|
|
EXPECT_EQ(DW_TAG_invalid, getTag("something else"));
|
|
|
|
// Tag range markers should not be recognized.
|
|
EXPECT_EQ(DW_TAG_invalid, getTag("DW_TAG_lo_user"));
|
|
EXPECT_EQ(DW_TAG_invalid, getTag("DW_TAG_hi_user"));
|
|
EXPECT_EQ(DW_TAG_invalid, getTag("DW_TAG_user_base"));
|
|
}
|
|
|
|
TEST(DwarfTest, getOperationEncoding) {
|
|
// Some valid ops.
|
|
EXPECT_EQ(DW_OP_deref, getOperationEncoding("DW_OP_deref"));
|
|
EXPECT_EQ(DW_OP_bit_piece, getOperationEncoding("DW_OP_bit_piece"));
|
|
|
|
// Invalid ops.
|
|
EXPECT_EQ(0u, getOperationEncoding("DW_OP_otherthings"));
|
|
EXPECT_EQ(0u, getOperationEncoding("other"));
|
|
|
|
// Markers shouldn't be recognized.
|
|
EXPECT_EQ(0u, getOperationEncoding("DW_OP_lo_user"));
|
|
EXPECT_EQ(0u, getOperationEncoding("DW_OP_hi_user"));
|
|
}
|
|
|
|
TEST(DwarfTest, LanguageStringOnInvalid) {
|
|
// This is invalid, so it shouldn't be stringified.
|
|
EXPECT_EQ(StringRef(), LanguageString(0));
|
|
|
|
// These aren't really tags: they describe ranges within tags. They
|
|
// shouldn't be stringified either.
|
|
EXPECT_EQ(StringRef(), LanguageString(DW_LANG_lo_user));
|
|
EXPECT_EQ(StringRef(), LanguageString(DW_LANG_hi_user));
|
|
}
|
|
|
|
TEST(DwarfTest, getLanguage) {
|
|
// A couple of valid languages.
|
|
EXPECT_EQ(DW_LANG_C89, getLanguage("DW_LANG_C89"));
|
|
EXPECT_EQ(DW_LANG_C_plus_plus_11, getLanguage("DW_LANG_C_plus_plus_11"));
|
|
EXPECT_EQ(DW_LANG_OCaml, getLanguage("DW_LANG_OCaml"));
|
|
EXPECT_EQ(DW_LANG_Mips_Assembler, getLanguage("DW_LANG_Mips_Assembler"));
|
|
|
|
// Invalid languages.
|
|
EXPECT_EQ(0u, getLanguage("DW_LANG_invalid"));
|
|
EXPECT_EQ(0u, getLanguage("DW_TAG_array_type"));
|
|
EXPECT_EQ(0u, getLanguage("something else"));
|
|
|
|
// Language range markers should not be recognized.
|
|
EXPECT_EQ(0u, getLanguage("DW_LANG_lo_user"));
|
|
EXPECT_EQ(0u, getLanguage("DW_LANG_hi_user"));
|
|
}
|
|
|
|
TEST(DwarfTest, AttributeEncodingStringOnInvalid) {
|
|
// This is invalid, so it shouldn't be stringified.
|
|
EXPECT_EQ(StringRef(), AttributeEncodingString(0));
|
|
|
|
// These aren't really tags: they describe ranges within tags. They
|
|
// shouldn't be stringified either.
|
|
EXPECT_EQ(StringRef(), AttributeEncodingString(DW_ATE_lo_user));
|
|
EXPECT_EQ(StringRef(), AttributeEncodingString(DW_ATE_hi_user));
|
|
}
|
|
|
|
TEST(DwarfTest, getAttributeEncoding) {
|
|
// A couple of valid languages.
|
|
EXPECT_EQ(DW_ATE_boolean, getAttributeEncoding("DW_ATE_boolean"));
|
|
EXPECT_EQ(DW_ATE_imaginary_float,
|
|
getAttributeEncoding("DW_ATE_imaginary_float"));
|
|
|
|
// Invalid languages.
|
|
EXPECT_EQ(0u, getAttributeEncoding("DW_ATE_invalid"));
|
|
EXPECT_EQ(0u, getAttributeEncoding("DW_TAG_array_type"));
|
|
EXPECT_EQ(0u, getAttributeEncoding("something else"));
|
|
|
|
// AttributeEncoding range markers should not be recognized.
|
|
EXPECT_EQ(0u, getAttributeEncoding("DW_ATE_lo_user"));
|
|
EXPECT_EQ(0u, getAttributeEncoding("DW_ATE_hi_user"));
|
|
}
|
|
|
|
TEST(DwarfTest, VirtualityString) {
|
|
EXPECT_EQ(StringRef("DW_VIRTUALITY_none"),
|
|
VirtualityString(DW_VIRTUALITY_none));
|
|
EXPECT_EQ(StringRef("DW_VIRTUALITY_virtual"),
|
|
VirtualityString(DW_VIRTUALITY_virtual));
|
|
EXPECT_EQ(StringRef("DW_VIRTUALITY_pure_virtual"),
|
|
VirtualityString(DW_VIRTUALITY_pure_virtual));
|
|
|
|
// DW_VIRTUALITY_max should be pure virtual.
|
|
EXPECT_EQ(StringRef("DW_VIRTUALITY_pure_virtual"),
|
|
VirtualityString(DW_VIRTUALITY_max));
|
|
|
|
// Invalid numbers shouldn't be stringified.
|
|
EXPECT_EQ(StringRef(), VirtualityString(DW_VIRTUALITY_max + 1));
|
|
EXPECT_EQ(StringRef(), VirtualityString(DW_VIRTUALITY_max + 77));
|
|
}
|
|
|
|
TEST(DwarfTest, getVirtuality) {
|
|
EXPECT_EQ(DW_VIRTUALITY_none, getVirtuality("DW_VIRTUALITY_none"));
|
|
EXPECT_EQ(DW_VIRTUALITY_virtual, getVirtuality("DW_VIRTUALITY_virtual"));
|
|
EXPECT_EQ(DW_VIRTUALITY_pure_virtual,
|
|
getVirtuality("DW_VIRTUALITY_pure_virtual"));
|
|
|
|
// Invalid strings.
|
|
EXPECT_EQ(DW_VIRTUALITY_invalid, getVirtuality("DW_VIRTUALITY_invalid"));
|
|
EXPECT_EQ(DW_VIRTUALITY_invalid, getVirtuality("DW_VIRTUALITY_max"));
|
|
EXPECT_EQ(DW_VIRTUALITY_invalid, getVirtuality("something else"));
|
|
}
|
|
|
|
TEST(DwarfTest, FixedFormSizes) {
|
|
Optional<uint8_t> RefSize;
|
|
Optional<uint8_t> AddrSize;
|
|
|
|
// Test 32 bit DWARF version 2 with 4 byte addresses.
|
|
FormParams Params_2_4_32 = {2, 4, DWARF32};
|
|
RefSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_2_4_32);
|
|
AddrSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_2_4_32);
|
|
EXPECT_TRUE(RefSize.hasValue());
|
|
EXPECT_TRUE(AddrSize.hasValue());
|
|
EXPECT_EQ(*RefSize, *AddrSize);
|
|
|
|
// Test 32 bit DWARF version 2 with 8 byte addresses.
|
|
FormParams Params_2_8_32 = {2, 8, DWARF32};
|
|
RefSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_2_8_32);
|
|
AddrSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_2_8_32);
|
|
EXPECT_TRUE(RefSize.hasValue());
|
|
EXPECT_TRUE(AddrSize.hasValue());
|
|
EXPECT_EQ(*RefSize, *AddrSize);
|
|
|
|
// DW_FORM_ref_addr is 4 bytes in DWARF 32 in DWARF version 3 and beyond.
|
|
FormParams Params_3_4_32 = {3, 4, DWARF32};
|
|
RefSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_3_4_32);
|
|
EXPECT_TRUE(RefSize.hasValue());
|
|
EXPECT_EQ(*RefSize, 4);
|
|
|
|
FormParams Params_4_4_32 = {4, 4, DWARF32};
|
|
RefSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_4_4_32);
|
|
EXPECT_TRUE(RefSize.hasValue());
|
|
EXPECT_EQ(*RefSize, 4);
|
|
|
|
FormParams Params_5_4_32 = {5, 4, DWARF32};
|
|
RefSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_5_4_32);
|
|
EXPECT_TRUE(RefSize.hasValue());
|
|
EXPECT_EQ(*RefSize, 4);
|
|
|
|
// DW_FORM_ref_addr is 8 bytes in DWARF 64 in DWARF version 3 and beyond.
|
|
FormParams Params_3_8_64 = {3, 8, DWARF64};
|
|
RefSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_3_8_64);
|
|
EXPECT_TRUE(RefSize.hasValue());
|
|
EXPECT_EQ(*RefSize, 8);
|
|
|
|
FormParams Params_4_8_64 = {4, 8, DWARF64};
|
|
RefSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_4_8_64);
|
|
EXPECT_TRUE(RefSize.hasValue());
|
|
EXPECT_EQ(*RefSize, 8);
|
|
|
|
FormParams Params_5_8_64 = {5, 8, DWARF64};
|
|
RefSize = getFixedFormByteSize(DW_FORM_ref_addr, Params_5_8_64);
|
|
EXPECT_TRUE(RefSize.hasValue());
|
|
EXPECT_EQ(*RefSize, 8);
|
|
}
|
|
|
|
TEST(DwarfTest, format_provider) {
|
|
EXPECT_EQ("DW_AT_name", formatv("{0}", DW_AT_name).str());
|
|
EXPECT_EQ("DW_AT_unknown_3fff", formatv("{0}", DW_AT_hi_user).str());
|
|
EXPECT_EQ("DW_FORM_addr", formatv("{0}", DW_FORM_addr).str());
|
|
EXPECT_EQ("DW_FORM_unknown_1f00", formatv("{0}", DW_FORM_lo_user).str());
|
|
EXPECT_EQ("DW_IDX_compile_unit", formatv("{0}", DW_IDX_compile_unit).str());
|
|
EXPECT_EQ("DW_IDX_unknown_3fff", formatv("{0}", DW_IDX_hi_user).str());
|
|
EXPECT_EQ("DW_TAG_compile_unit", formatv("{0}", DW_TAG_compile_unit).str());
|
|
EXPECT_EQ("DW_TAG_unknown_ffff", formatv("{0}", DW_TAG_hi_user).str());
|
|
}
|
|
} // end namespace
|