Skip to content
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.

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

add SPIR-V version testing #1861

Merged
merged 7 commits into from
Jan 30, 2024
Merged

Conversation

bashbaug
Copy link
Contributor

This PR adds basic testing for each of the SPIR-V versions supported by an OpenCL device. It queries which SPIR-V versions are supported (using CL_DEVICE_IL_VERSION), and then compiles a SPIR-V program and executes a simple kernel for each of the reported versions. Note that none of the new features for each SPIR-V version are tested, but this PR does include infrastructure that could be (and hopefully will be!) used to add targeted testing for version-specific SPIR-V features in the future.

fixes #1069
see also #1639

@haonanya
Copy link

@bashbaug, could you please offer run command for added tests? I am not familiar with CTS and having a try to verify it on intel OCL CPURT. Thanks very much.

[haonanya@ spirv_new]$ ./test_spirv_new basic_versions
Reading SPIR-V files from default 'spirv_bin' path.
In case you want to set other directory use '--spirv-binaries-path' argument.
To skip the SPIR-V version check use the '--skip-spirv-version-check' argument.
Initializing random seed to 0.
Requesting Default device based on command line for platform index 0 and device index 0
Compute Device Name = Intel(R) FPGA Emulation Device, Compute Device Vendor = Intel(R) Corporation, Compute Device Version = OpenCL 1.2 , CL C Version = OpenCL C 1.2
Supports single precision denormals: YES
sizeof( void*) = 8 (host)
sizeof( void*) = 8 (device)
This device supports SPIR-V offline compilation. SPIR-V version is 1.4
basic_versions...
testing SPIR-V_1.0...
File spirv_bin//basic.spv64 not found
File /basic not found
ERROR: Unable to build SPIR-V program! (CL_DEVICE_NOT_FOUND from /export/users/haonanya/OpenCLCTS/OpenCL-CTS/test_conformance/spirv_new/test_basic_versions.cpp:92)
basic_versions FAILED
PASSED sub-test.
FAILED test.

@bashbaug
Copy link
Contributor Author

Sure - I always forget how to do this so I have a text file with my notes. Here's what I do:

Step 1: Build the spirv_new tests:

make -j20 test_spirv_new

Step 2: Assemble SPIR-V files:
This needs to be done once, or whenever SPIR-V files are added.

pushd ../test_conformance/spirv_new/ && python3 ./assemble_spirv.py && popd

Step 3: Run the tests:
Be sure to point to the SPIR-V binaries!

./test_conformance/spirv_new/test_spirv_new --spirv-binaries-path ../test_conformance/spirv_new/spirv_bin/

@bashbaug
Copy link
Contributor Author

I'd like to add more testing for newer SPIR-V features and I'm going to need some of this infrastructure, so adding "focused review".

@haonanya
Copy link

basic_versions

Thank you @bashbaug! Test pass with intel OCL CPURT. Is supported SPIRV-V version is up to 1.4 according to https://github.com/KhronosGroup/SPIRV-LLVM-Translator/blob/main/docs/SPIRVVersionsAndExtensionsHandling.rst?plain=1#L68? Thanks very much.

@svenvh svenvh self-requested a review January 25, 2024 18:26
Copy link
Member

@svenvh svenvh left a comment

Choose a reason for hiding this comment

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

LGTM

@bashbaug
Copy link
Contributor Author

Merging as discussed in the January 30th teleconference.

@bashbaug bashbaug merged commit d5b7d10 into KhronosGroup:main Jan 30, 2024
5 of 6 checks passed
@bashbaug bashbaug deleted the spirv-version-testing branch January 30, 2024 17:14
bashbaug added a commit that referenced this pull request Mar 3, 2024
* allocations: Move results array from stack to heap (#1857)

* allocations: Fix stack overflow

* check format fixes

* Fix windows stack overflow. (#1839)

* thread_dimensions: Avoid combinations of very small LWS and very large GWS (#1856)

Modify the existing condition to include extremely small LWS like
1x1 on large GWS values

* c11_atomics: Reduce the loopcounter for sequential consistency tests (#1853)

Reduce the loop from 1000000 to 500000 since the former value
makes the test run too long and cause system issues on certain
platforms

* Limit individual allocation size using the global memory size (#1835)

Signed-off-by: Ahmed Hesham <[email protected]>

* geometrics: fix Wsign-compare warnings (#1855)

Signed-off-by: Sven van Haastregt <[email protected]>

* integer_ops: fix -Wformat warnings (#1860)

The main sources of warnings were:

 * Printing of a `size_t` which requires the `%zu` specifier.

 * Printing of `cl_long`/`cl_ulong` which is now done using the
   `PRI*64` macros to ensure portability across 32 and 64-bit builds.

Signed-off-by: Sven van Haastregt <[email protected]>

* Replace OBSOLETE_FORAMT with OBSOLETE_FORMAT (#1776)

* Replace OBSOLETE_FORAMT with OBSOLETE_FORMAT

In imageHelpers.cpp and few other places in image tests, OBSOLETE_FORMAT is misspelled as OBSOLETE_FORAMT.
Fix misspelling by replcaing it with OBSOLETE_FORMAT.

Fixes #1769

* Remove code guarded by OBSOLETE_FORMAT

Remove code guarded by OBSOLETE_FORMAT
as suggested by review comments

Fixes #1769

* Fix formating issues for OBSOLETE_FORMAT changes

Fix formatting issues observed in files while removing
code guarded by OBSOLETE_FORMAT

Fixes #1769

* Some more formatting fixes

Some more formatting fixes to get CI clean

Fixes #1769

* Final Formating fixes

Final formatting fixes for #1769

* Enhancement: Thread dimensions user parameters (#1384)

* Fix format in the test scope

* Add user params to limit testing

Add parameters to reduce amount of testing.
Helpful for debugging or for machines with lower performance.

* Restore default value

* Print info only if testing params bigger than 0.

* [NFC] conversions: reenable Wunused-but-set-variable (#1845)

Remove an assigned-to but unused variable.

Reenable the Wunused-but-set-variable warning for the conversions
suite, as it now compiles cleanly with this warning enabled.

Signed-off-by: Sven van Haastregt <[email protected]>

* Fix bug of conversion from long to double (#1847)

* Fix bug of conversion from long to double

It the input is long type, it should be load as long type, not ulong.

* update long2float

* math_brute_force: fix exp/exp2 rlx ULP calculation (#1848)

Fix the ULP error calculation for the `exp` and `exp2` builtins in
relaxed math mode for the full profile.

Previously, the `ulps` value kept being added to while verifying the
result buffer in a loop.  `ulps` could even become a `NaN` when the
input argument being tested was a `NaN`.

Signed-off-by: Sven van Haastregt <[email protected]>

* Enable LARGEADDRESSAWARE for 32 bit compilation (#1858)

* Enable LARGEADDRESSAWARE for 32 bit compilation

32-bit executables built with MSVC linker have only 2GB virtual memory
address space by default, which might not be sufficient for some tests.

Enable LARGEADDRESSAWARE linker flag for 32-bit targets to allow tests
to handle addresses larger than 2 gigabytes.

https://learn.microsoft.com/en-us/cpp/build/reference/largeaddressaware-handle-large-addresses?view=msvc-170

Signed-off-by: Guo, Yilong <[email protected]>

* Apply suggestion

Co-authored-by: Ben Ashbaugh <[email protected]>

---------

Signed-off-by: Guo, Yilong <[email protected]>
Co-authored-by: Ben Ashbaugh <[email protected]>

* fix return code when readwrite image is not supported (#1873)

This function (do_test) starts by testing write and read individually.
Both of them can have errors.

When readwrite image is not supported, the function returns
TEST_SKIPPED_ITSELF potentially masking errors leading to the test
returning EXIT_SUCCESS even with errors along the way.

* fix macos builds by avoiding double compilation of function_list.cpp for test_spir (#1866)

* modernize CMakeLists for test_spir

* add the operating system release to the sccache key

* include the math brute force function list vs. building it twice

* fix the license header on the spirv-new tests (#1865)

The source files for the spirv-new tests were using the older Khronos
license instead of the proper Apache license.  Fixed the license in
all source files.

* compiler: fix grammar in error message (#1877)

Signed-off-by: Sven van Haastregt <[email protected]>

* Updated semaphore tests to use clSemaphoreReImportSyncFdKHR. (#1854)

* Updated semaphore tests to use clSemaphoreReImportSyncFdKHR.

Additionally updated common semaphore code to handle spec updates
that restrict simultaneous importing/exporting of handles.

* Fix build issues on CI

* gcc build issues

* Make clReImportSemaphoreSyncFdKHR a required API
call if cl_khr_external_semaphore_sync_fd is present.

* Implement signal and wait for all semaphore types.

* subgroups: fix for testing too large WG sizes (#1620)

It seemed to be a typo; the comment says that it
tries to fetch local size for a subgroup count with
above max WG size, but it just used the previous
subgroup count.

The test on purpose sets a SG count to be a larger
number than the max work-items in the work group.
Given the minimum SG size is 1 WI, it means that there
can be a maximum of maximum work-group size of SGs (of
1 WI of size). Thus, if we request a number of SGs that
exceeds the local size, the query should fail as expected.

* add SPIR-V version testing (#1861)

* basic SPIR-V 1.3 testing support

* updated script to compile for more SPIR-V versions

* switch to general SPIR-V versions test

* update copyright text and fix license

* improve output while test is running

* check for higher SPIR-V versions first

* fix formatting

* fix the reported platform information for math brute force (#1884)

When the math brute force test printed the platform version it always
printed information for the first platform in the system, which could
be different than the platform for the passed-in device.  Fixed by
querying the platform from the passed-in device instead.

* api tests fix: Use MTdataHolder in test_get_image_info (#1871)

* Minor fixes in mutable dispatch tests. (#1829)

* Minor fixes in mutable dispatch tests.

* Fix size of newWrapper in MutableDispatchSVMArguments.
* Fix errnoneus clCommandNDRangeKernelKHR call.

Signed-off-by: John Kesapides <[email protected]>

* * Set the row_pitch for imageInfo in MutableDispatchImage1DArguments
and MutableDispatchImage2DArguments. The row_pitch is
used by get_image_size() to calculate the size of
the host pointers by generate_random_image_data.

Signed-off-by: John Kesapides <[email protected]>

---------

Signed-off-by: John Kesapides <[email protected]>

* add test for cl_khr_spirv_linkonce_odr (#1226)

* initial version of the test with placeholders for linkonce_odr linkage

* add OpExtension SPV_KHR_linkonce_odr extension

* add check for extension

* switch to actual LinkOnceODR linkage

* fix formatting

* add a test case to ensure a function with linkonce_odr is exported

* add back the extension check

* fix formatting

* undo compiler optimization and actually add the call to function a

* [NFC] subgroups: remove unnecessary extern keywords (#1892)

In C and C++ all functions have external linkage by default.

Also remove the unused `gMTdata` and `test_pipe_functions`
declarations.

Fixes #1137

Signed-off-by: Sven van Haastregt <[email protected]>

* Added cl_khr_fp16 extension support for test_decorate from spirv_new (#1770)

* Added cl_khr_fp16 extension support for test_decorate from spirv_new, work in progres

* Complemented test_decorate saturation test to support cl_khr_fp16 extension (issue #142)

* Fixed clang format

* scope of modifications:

-changed naming convention of saturation .spvasm files related to
test_decorate of spirv_new
-restored float to char/uchar saturation tests
-few minor corrections

* fix ranges for half testing

* fix formating

* one more formatting fix

* remove unused function

* use isnan instead of std::isnan

isnan is currently implemented as a macro, not as a function, so
we can't use std::isnan.

* fix Clang warning about inexact conversion

---------

Co-authored-by: Ben Ashbaugh <[email protected]>

* add support for custom devices (#1891)

enable the CTS to run on custom devices

---------

Signed-off-by: Ahmed Hesham <[email protected]>
Signed-off-by: Sven van Haastregt <[email protected]>
Signed-off-by: Guo, Yilong <[email protected]>
Signed-off-by: John Kesapides <[email protected]>
Co-authored-by: Sreelakshmi Haridas Maruthur <[email protected]>
Co-authored-by: Haonan Yang <[email protected]>
Co-authored-by: Ahmed Hesham <[email protected]>
Co-authored-by: Sven van Haastregt <[email protected]>
Co-authored-by: niranjanjoshi121 <[email protected]>
Co-authored-by: Grzegorz Wawiorko <[email protected]>
Co-authored-by: Wenwan Xing <[email protected]>
Co-authored-by: Yilong Guo <[email protected]>
Co-authored-by: Romaric Jodin <[email protected]>
Co-authored-by: joshqti <[email protected]>
Co-authored-by: Pekka Jääskeläinen <[email protected]>
Co-authored-by: imilenkovic00 <[email protected]>
Co-authored-by: John Kesapides <[email protected]>
Co-authored-by: Marcin Hajder <[email protected]>
Co-authored-by: Aharon Abramson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

testing supported SPIR-V / IL versions
3 participants