Skip to content

Add comparison rule, tolerance if applicable, and hex64 view to test failure text output #291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Jul 28, 2025
Merged

Add comparison rule, tolerance if applicable, and hex64 view to test failure text output #291

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
796dd2e
add comparison rule, tolerance if applicable, and hex64 view to test …
bob80905 Jul 17, 2025
d2f03d1
make sure hex representation is correct
bob80905 Jul 18, 2025
1dccd9c
address build errors
bob80905 Jul 18, 2025
21c5b1e
fix typo
bob80905 Jul 18, 2025
78467e7
print as strings, use standard hex float format for C++
bob80905 Jul 21, 2025
d9ee686
try applying clangformat
bob80905 Jul 21, 2025
db2f5ea
clang format
bob80905 Jul 21, 2025
cde6fee
add hex data text after the yaml
bob80905 Jul 22, 2025
f8fd606
try clang-format
bob80905 Jul 22, 2025
7a7634a
address build errors
bob80905 Jul 22, 2025
edb7c30
use std::hex for exact tests
bob80905 Jul 22, 2025
bb0b384
address Alex
bob80905 Jul 23, 2025
0d167eb
address Alex + Finn
bob80905 Jul 25, 2025
4bc8e29
fix missing output props bug
bob80905 Jul 25, 2025
72bd6d8
use appropriate variable naming rules
bob80905 Jul 25, 2025
2a9c56b
clarify comment
bob80905 Jul 25, 2025
33d3eac
more variable rule fixes
bob80905 Jul 25, 2025
2517d5e
more build errors
bob80905 Jul 25, 2025
d2f8e25
prefix hex values with 0x
bob80905 Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions include/Support/Pipeline.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ struct Buffer {
int Channels;
int Stride;
std::unique_ptr<char[]> Data;
std::unique_ptr<llvm::yaml::Hex64> HexData;
size_t Size;
size_t HexSize;
OutputProperties OutputProps;
uint32_t Counter;

Expand Down
10 changes: 9 additions & 1 deletion lib/Support/Check.cpp
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Do we want to add a test case of the correct error message output?

We could use FileCheck to ensure the hex values or whatnot are being formatted as expected

Original file line number Diff line number Diff line change
Expand Up @@ -268,26 +268,34 @@ static bool testBufferFloatULP(offloadtest::Buffer *B1, offloadtest::Buffer *B2,
}

llvm::Error verifyResult(offloadtest::Result R) {
llvm::SmallString<256> TestRuleStr;
llvm::raw_svector_ostream TestRuleOStr(TestRuleStr);
switch (R.ComparisonRule) {
case offloadtest::Rule::BufferExact: {
if (testBufferExact(R.ActualPtr, R.ExpectedPtr))
return llvm::Error::success();
TestRuleOStr << "Comparison Rule: BufferExact\n";
break;
}
case offloadtest::Rule::BufferFloatULP: {
if (testBufferFloatULP(R.ActualPtr, R.ExpectedPtr, R.ULPT, R.DM))
return llvm::Error::success();
TestRuleOStr << "Comparison Rule: BufferFloatULP\nULP: " << R.ULPT << "\n";
break;
}
case offloadtest::Rule::BufferFloatEpsilon: {
if (testBufferFloatEpsilon(R.ActualPtr, R.ExpectedPtr, R.Epsilon, R.DM))
return llvm::Error::success();
TestRuleOStr << "Comparison Rule: BufferFloatEpsilon\nEpsilon: "
<< R.Epsilon << "\n";
break;
}
}
llvm::SmallString<256> Str;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit: Would it make sense to move the declarations of Str and OS to the beginning of this function and get rid of TestRuleStr and TestRuleOStr? Would probably want to increase the size of the llvm::SmallString in that case.

llvm::raw_svector_ostream OS(Str);
OS << "Test failed: " << R.Name << "\nExpected:\n";
OS << "Test failed: " << R.Name << "\n";
OS << TestRuleStr;
OS << "Expected:\n";
llvm::yaml::Output YAMLOS(OS);
YAMLOS << *R.ExpectedPtr;
OS << "Got:\n";
Expand Down
13 changes: 13 additions & 0 deletions lib/Support/Pipeline.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@ void MappingTraits<offloadtest::DescriptorSet>::mapping(
I.mapRequired("Resources", D.Resources);
}

template <typename T> static uint64_t bitPatternAsHex64(const T &Val) {
static_assert(sizeof(T) <= sizeof(uint64_t), "Type too large for Hex64");
uint64_t Raw = 0;
memcpy(&Raw, &Val, sizeof(T));
return Raw;
}

void MappingTraits<offloadtest::Buffer>::mapping(IO &I,
offloadtest::Buffer &B) {
I.mapRequired("Name", B.Name);
Expand All @@ -108,7 +115,13 @@ void MappingTraits<offloadtest::Buffer>::mapping(IO &I,
if (I.outputting()) { \
llvm::MutableArrayRef<Type> Arr(reinterpret_cast<Type *>(B.Data.get()), \
B.Size / sizeof(Type)); \
std::vector<llvm::yaml::Hex64> HexVec; \
HexVec.reserve(Arr.size()); \
for (const auto &val : Arr) \
HexVec.emplace_back(bitPatternAsHex64(val)); \
llvm::MutableArrayRef<llvm::yaml::Hex64> HexArr(HexVec); \
I.mapRequired("Data", Arr); \
I.mapRequired("HexData", HexArr); \
} else { \
int64_t ZeroInitSize; \
I.mapOptional("ZeroInitSize", ZeroInitSize, 0); \
Expand Down