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

Compatibility: Only use cl_* types if SYCL_CTS_ENABLE_OPENCL_INTEROP_TESTS is set #873

Merged
merged 5 commits into from
Oct 3, 2024

Conversation

fknorr
Copy link
Contributor

@fknorr fknorr commented Feb 17, 2024

This improves compatibility with implementations that do not expose OpenCL interop (notably SimSYCL, and AFAIK also AdaptiveCpp / hipSYCL).

This change is probably incomplete, but enough to get some tests to build with SimSYCL that otherwise wouldn't.

group_async_work_group_copy.cpp had !is_same checks between cl types and stdint types - please correct me if it's wrong to remove these checks, it appears to me as though performing the same check twice is not an issue - but maybe there's symbol clashes.

@fknorr fknorr requested a review from a team as a code owner February 17, 2024 19:39
@fknorr fknorr changed the title Compatibility: Only use cl_* types if SYCL_CTS_ENABLE_OPENCL_INTEROP_TESTS is set Compatibility: Only use cl_* types if SYCL_CTS_ENABLE_OPENCL_INTEROP_TESTS is set Feb 17, 2024
@@ -37,8 +37,10 @@ class TEST_NAME : public util::test_base {
// Test using queue constructed already
for_type_and_vectors<check_type, sycl::half>(queue, log,
"sycl::half");
#if SYCL_CTS_ENABLE_OPENCL_INTEROP_TESTS
for_type_and_vectors<check_type, sycl::cl_half>(queue, log,
"sycl::cl_half");
Copy link
Contributor

Choose a reason for hiding this comment

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

The tests seem to be outdated.
Spec says:

For the purpose of interoperability and portability, SYCL defines a set of aliases to C++ types within the sycl::opencl namespace using the cl_ prefix.

Suggested change
"sycl::cl_half");
"sycl::opencl::cl_half");

Right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated most uses of cl_*, however there's the cl_float4 etc vector types which also seem to be deprecated, and DPC++ doesn't alias them into opencl::. I've left those alone.

Copy link
Contributor

Choose a reason for hiding this comment

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

there's the cl_float4 etc vector types which also seem to be deprecated, and DPC++ doesn't alias them into opencl::.

@steffenlarsen, could you please check the DPC++, please? I found intel/llvm@e98d732 by @AlexeySachkov, which adds aliases for scalar types, but I don't see definitions for vector aliases in https://github.com/intel/llvm/blob/e89da3251187ec101f995a8dbf6e832043baebdc/sycl/include/sycl/aliases.hpp.

We need to create trackers to fix both CTS tests (i.e. sycl::cl_float4 -> sycl::opencl::cl_float4) and DPC++ implementation (i.e. implement sycl::opencl::cl_float4).

Copy link
Contributor

Choose a reason for hiding this comment

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

I found the spec defines aliases only for scalar OpenCL types https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#_data_types_2.

The OpenCL C language standard Section 6.11 defines its own built-in scalar data types, and these have additional requirements in terms of size and signedness on top of what is guaranteed by ISO C++. For the purpose of interoperability and portability, SYCL defines a set of aliases to C++ types within the sycl::opencl namespace using the cl_ prefix. These aliases are described in Table 182.

I'm not sure what is the reason to skip vector types, but at the moment, we can open an issue for SYCL-CTS to replace OpenCL vector type aliases with sycl::vec type (i.e. sycl::cl_float4 -> sycl::vec<sycl::opencl::cl_float, 4>).

I recalled that @AlexeySachkov already filed an issue about missing vector aliases - KhronosGroup/SYCL-Docs#335, but it's still unresolved.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree with you analysis, but it sounds like DPC++ is defining the right aliases until KhronosGroup/SYCL-Docs#335 is resolved. Please correct me if I'm wrong.


#ifdef INT8_MAX
if (!std::is_same<sycl::cl_char, std::int8_t>::value)
for_type_and_vectors<check_type, std::int8_t>(log, "std::int8_t");
for_type_and_vectors<check_type, std::int8_t>(log, "std::int8_t");
Copy link
Contributor

Choose a reason for hiding this comment

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

This introduces duplication into the test. But you can move the if condition under #if SYCL_CTS_ENABLE_OPENCL_INTEROP_TESTS.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, although this makes things a lot more verbose.


#ifdef INT8_MAX
if (!std::is_same<sycl::cl_char, std::int8_t>::value)
Copy link
Member

Choose a reason for hiding this comment

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

I wonder how these tests could have been false at the first place.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think they can, integer widths are part of the spec.

@keryell
Copy link
Member

keryell commented Jun 13, 2024

@fknorr Some merge from upstream?

Copy link
Contributor

@bader bader left a comment

Choose a reason for hiding this comment

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

@fknorr, thanks!
LGTM. Please, fix check-clang-format.

@bader bader requested a review from keryell September 16, 2024 15:00
@fknorr
Copy link
Contributor Author

fknorr commented Sep 17, 2024

Should be good to go now.

@bader
Copy link
Contributor

bader commented Sep 17, 2024

Should be good to go now.

@fknorr, thanks for fixing CI checks. We need to wait for @keryell to approve.

Copy link
Member

@keryell keryell left a comment

Choose a reason for hiding this comment

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

Thanks!

@bader bader merged commit bbe812f into KhronosGroup:SYCL-2020 Oct 3, 2024
8 checks passed
@fknorr fknorr deleted the compat-cl-interop branch October 6, 2024 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants