Update LongVector Execution tests to now use XML (#7393)

This change refactors the LongVector exec tests into their own files and
swaps to use the XML and statically defined values for test input.

1. Update the LongVector exec tests to use the ShaderOpArithTable.xml
TAEF table file for test entry points. This aligns with existing HLK
tests.
2. Some light code cleanup.
3. Hard coded value sets in LongVectorTestData.h. Value sets give us a
simple way to generate larger arrays from a smaller set of statically
defined values. At a later point we can add logic to produce value sets
at build time in this same header by consuming from a YAML file used in
the offload test suite.
4. Move LongVector tests into their own LongVector.h, LongVector.tpp,
and LongVector.cpp files.
5. Add an HLSLExecTestUtils.h file to hold some common logic to
facilitate re-factoring the LongVector tests into their own files.

This PR ended up growing larger than intended. Subsequent PRs will be
smaller chunks.
There are some additional refactoring and clean-up changes coming but I
did not want to continue to add to this PR.

Author: alsepkow

include/dxc/Test/HlslTestUtils.h

@@ -10,6 +10,8 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 // *** THIS FILE CANNOT TAKE ANY LLVM DEPENDENCIES  *** //
+#ifndef HLSLTESTUTILS_H
+#define HLSLTESTUTILS_H
 
 #include <algorithm>
 #include <atomic>
@@ -258,17 +260,29 @@ inline void LogErrorFmt(const wchar_t *fmt, ...) {
   WEX::Logging::Log::Error(buf.data());
 }
 
-inline void LogErrorFmtThrow(const wchar_t *fmt, ...) {
+inline void LogErrorFmtThrow(const char *fileName, int line, const wchar_t *fmt,
+                             ...) {
   va_list args;
   va_start(args, fmt);
   std::wstring buf(vFormatToWString(fmt, args));
   va_end(args);
-  WEX::Logging::Log::Error(buf.data());
+
+  std::wstringstream wss;
+  wss << L"Error in file: " << fileName << L" at line: " << line << L"\n"
+      << buf.data() << L"\n"
+      << buf;
+
+  WEX::Logging::Log::Error(wss.str().c_str());
 
   // Throws an exception to abort the test.
   VERIFY_FAIL(L"Test error");
 }
 
+// Macro to pass the file name and line number. Otherwise TAEF prints this file
+// and line number.
+#define LOG_ERROR_FMT_THROW(fmt, ...)                                          \
+  hlsl_test::LogErrorFmtThrow(__FILE__, __LINE__, fmt, __VA_ARGS__)
+
 inline std::wstring
 GetPathToHlslDataFile(const wchar_t *relative,
                       LPCWSTR paramName = HLSLDATAFILEPARAM,
@@ -553,6 +567,19 @@ inline bool CompareDoubleULP(
   return AbsoluteDiff <= (uint64_t)ULPTolerance;
 }
 
+inline bool CompareDoubleEpsilon(const double &Src, const double &Ref,
+                                 float Epsilon) {
+  if (Src == Ref) {
+    return true;
+  }
+  if (std::isnan(Src)) {
+    return std::isnan(Ref);
+  }
+  // For FTZ or Preserve mode, we should get the expected number within
+  // epsilon for any operations.
+  return fabs(Src - Ref) < Epsilon;
+}
+
 inline bool CompareFloatULP(
     const float &fsrc, const float &fref, int ULPTolerance,
     hlsl::DXIL::Float32DenormMode mode = hlsl::DXIL::Float32DenormMode::Any) {
@@ -604,12 +631,26 @@ inline bool CompareFloatRelativeEpsilon(
 
 inline bool CompareHalfULP(const uint16_t &fsrc, const uint16_t &fref,
                            float ULPTolerance) {
+  // Treat +0 and -0 as equal
+  if ((fsrc & ~FLOAT16_BIT_SIGN) == 0 && (fref & ~FLOAT16_BIT_SIGN) == 0)
+    return true;
   if (fsrc == fref)
     return true;
-  if (isnanFloat16(fsrc))
-    return isnanFloat16(fref);
+
+  const bool nanRef = isnanFloat16(fref);
+  const bool nanSrc = isnanFloat16(fsrc);
+  if (nanRef || nanSrc)
+    return nanRef && nanSrc;
+
+  // Map to monotonic ordering for correct ULP diff
+  auto toOrdered = [](uint16_t h) -> int {
+    return (h & FLOAT16_BIT_SIGN) ? (~h & 0xFFFF) : (h | 0x8000);
+  };
+
   // 16-bit floating point numbers must preserve denorms
-  int diff = fsrc - fref;
+  int i_fsrc = toOrdered(fsrc);
+  int i_fref = toOrdered(fref);
+  int diff = i_fsrc - i_fref;
   unsigned int uDiff = diff < 0 ? -diff : diff;
   return uDiff <= (unsigned int)ULPTolerance;
 }
@@ -773,3 +814,5 @@ inline UINT GetByteSizeForFormat(DXGI_FORMAT value) {
   }
 }
 #endif
+
+#endif // HLSLTESTUTILS_H

tools/clang/unittests/HLSLExec/CMakeLists.txt

@@ -3,9 +3,13 @@
 find_package(TAEF REQUIRED)
 find_package(D3D12 REQUIRED) # Used for ExecutionTest.cpp.
 
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /bigobj")
+
 add_clang_library(ExecHLSLTests SHARED
   ExecutionTest.cpp
   ShaderOpTest.cpp
+  TableParameterHandler.cpp
+  LongVectors.cpp
   ExecHLSLTests.rc
   )
 

tools/clang/unittests/HLSLExec/ExecHLSLTests.rc

@@ -1,3 +1,4 @@
 #include <windows.h>
 
-ShaderOpArithTable.xml DATASOURCE_XML "ShaderOpArithTable.xml"
+ShaderOpArithTable.xml DATASOURCE_XML "ShaderOpArithTable.xml"
+LongVectorOpTable.xml DATASOURCE_XML "LongVectorOpTable.xml"