Skip to content

[SYCL] Deprecate legacy vector type aliases #8561

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 1 commit into from
Mar 10, 2023
Merged

[SYCL] Deprecate legacy vector type aliases #8561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 19 additions & 15 deletions sycl/include/sycl/aliases.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ class half;
#define __SYCL_MAKE_VECTOR_ALIAS(ALIAS, TYPE, N) \
using ALIAS##N = sycl::vec<TYPE, N>;

#define __SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(ALIAS, TYPE, N, MESSAGE) \
using ALIAS##N __SYCL2020_DEPRECATED(MESSAGE) = sycl::vec<TYPE, N>;

#define __SYCL_MAKE_VECTOR_ALIASES_FOR_ARITHMETIC_TYPES(N) \
__SYCL_MAKE_VECTOR_ALIAS(char, char, N) \
__SYCL_MAKE_VECTOR_ALIAS(short, short, N) \
Expand All @@ -36,18 +39,19 @@ class half;
__SYCL_MAKE_VECTOR_ALIAS(double, double, N) \
__SYCL_MAKE_VECTOR_ALIAS(half, half, N)

// There are no 'cl_*' vec aliases in SYCL 2020
#define __SYCL_MAKE_VECTOR_ALIASES_FOR_OPENCL_TYPES(N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_char, sycl::cl_char, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_uchar, sycl::cl_uchar, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_short, sycl::cl_short, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_ushort, sycl::cl_ushort, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_int, sycl::cl_int, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_uint, sycl::cl_uint, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_long, sycl::cl_long, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_ulong, sycl::cl_ulong, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_float, sycl::cl_float, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_double, sycl::cl_double, N) \
__SYCL_MAKE_VECTOR_ALIAS(cl_half, sycl::cl_half, N)
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_char, sycl::cl_char, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_uchar, sycl::cl_uchar, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_short, sycl::cl_short, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_ushort, sycl::cl_ushort, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_int, sycl::cl_int, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_uint, sycl::cl_uint, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_long, sycl::cl_long, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_ulong, sycl::cl_ulong, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_float, sycl::cl_float, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_double, sycl::cl_double, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(cl_half, sycl::cl_half, N, "")

#define __SYCL_MAKE_VECTOR_ALIASES_FOR_SIGNED_AND_UNSIGNED_TYPES(N) \
__SYCL_MAKE_VECTOR_ALIAS(schar, signed char, N) \
Expand All @@ -64,16 +68,16 @@ class half;
__SYCL_MAKE_VECTOR_ALIASES_FOR_SIGNED_AND_UNSIGNED_TYPES(N)

// FIXME: OpenCL vector aliases are not defined by SYCL 2020 spec and should be
// removed from here. See intel/llvm#7888
// removed from here. See intel/llvm#7888. They are deprecated for now.
// FIXME: schar, longlong and ulonglong aliases are not defined by SYCL 2020
// spec, but they are preserved in SYCL 2020 mode, because SYCL-CTS is
// still using them.
// See KhronosGroup/SYCL-CTS#446 and KhronosGroup/SYCL-Docs#335
#define __SYCL_2020_MAKE_VECTOR_ALIASES_FOR_VECTOR_LENGTH(N) \
__SYCL_MAKE_VECTOR_ALIASES_FOR_OPENCL_TYPES(N) \
__SYCL_MAKE_VECTOR_ALIAS(schar, std::int8_t, N) \
__SYCL_MAKE_VECTOR_ALIAS(longlong, std::int64_t, N) \
__SYCL_MAKE_VECTOR_ALIAS(ulonglong, std::uint64_t, N) \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(schar, std::int8_t, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(longlong, std::int64_t, N, "") \
__SYCL_2020_MAKE_DEPRECATED_VECTOR_ALIAS(ulonglong, std::uint64_t, N, "") \
__SYCL_MAKE_VECTOR_ALIAS(char, std::int8_t, N) \
__SYCL_MAKE_VECTOR_ALIAS(uchar, std::uint8_t, N) \
__SYCL_MAKE_VECTOR_ALIAS(short, std::int16_t, N) \
Expand Down
167 changes: 167 additions & 0 deletions sycl/test/warnings/deprecated-vector-aliases.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
// RUN: %clangxx %fsycl-host-only -fsyntax-only -sycl-std=2020 -Xclang -verify -Xclang -verify-ignore-unexpected=note %s
//
// Our implementation has a number of aliases defined for scalar types, which
// were either changed or completely removed from SYCL 2020. To ensure a smooth
// transition for users, we deprecated them first and then remove.
//
// This test is intended to check that we emit proper deprecation message for
// those aliases.

#include <sycl/sycl.hpp>

int main() {

// expected-warning@+1 {{'schar2' is deprecated}}
sycl::schar2 sc2;
// expected-warning@+1 {{'schar3' is deprecated}}
sycl::schar3 sc3;
// expected-warning@+1 {{'schar4' is deprecated}}
sycl::schar4 sc4;
// expected-warning@+1 {{'schar8' is deprecated}}
sycl::schar8 sc8;
// expected-warning@+1 {{'schar16' is deprecated}}
sycl::schar16 sc16;

// expected-warning@+1 {{'longlong2' is deprecated}}
sycl::longlong2 ll2;
// expected-warning@+1 {{'longlong3' is deprecated}}
sycl::longlong3 ll3;
// expected-warning@+1 {{'longlong4' is deprecated}}
sycl::longlong4 ll4;
// expected-warning@+1 {{'longlong8' is deprecated}}
sycl::longlong8 ll8;
// expected-warning@+1 {{'longlong16' is deprecated}}
sycl::longlong16 ll16;

// expected-warning@+1 {{'ulonglong2' is deprecated}}
sycl::ulonglong2 ull2;
// expected-warning@+1 {{'ulonglong3' is deprecated}}
sycl::ulonglong3 ull3;
// expected-warning@+1 {{'ulonglong4' is deprecated}}
sycl::ulonglong4 ull4;
// expected-warning@+1 {{'ulonglong8' is deprecated}}
sycl::ulonglong8 ull8;
// expected-warning@+1 {{'ulonglong16' is deprecated}}
sycl::ulonglong16 ull16;

// expected-warning@+1 {{'cl_char2' is deprecated}}
sycl::cl_char2 cl_c2;
// expected-warning@+1 {{'cl_char3' is deprecated}}
sycl::cl_char3 cl_c3;
// expected-warning@+1 {{'cl_char4' is deprecated}}
sycl::cl_char4 cl_c4;
// expected-warning@+1 {{'cl_char8' is deprecated}}
sycl::cl_char8 cl_c8;
// expected-warning@+1 {{'cl_char16' is deprecated}}
sycl::cl_char16 cl_c16;

// expected-warning@+1 {{'cl_uchar2' is deprecated}}
sycl::cl_uchar2 cl_uc2;
// expected-warning@+1 {{'cl_uchar3' is deprecated}}
sycl::cl_uchar3 cl_uc3;
// expected-warning@+1 {{'cl_uchar4' is deprecated}}
sycl::cl_uchar4 cl_uc4;
// expected-warning@+1 {{'cl_uchar8' is deprecated}}
sycl::cl_uchar8 cl_uc8;
// expected-warning@+1 {{'cl_uchar16' is deprecated}}
sycl::cl_uchar16 cl_uc16;

// expected-warning@+1 {{'cl_short2' is deprecated}}
sycl::cl_short2 cl_s2;
// expected-warning@+1 {{'cl_short3' is deprecated}}
sycl::cl_short3 cl_s3;
// expected-warning@+1 {{'cl_short4' is deprecated}}
sycl::cl_short4 cl_s4;
// expected-warning@+1 {{'cl_short8' is deprecated}}
sycl::cl_short8 cl_s8;
// expected-warning@+1 {{'cl_short16' is deprecated}}
sycl::cl_short16 cl_s16;

// expected-warning@+1 {{'cl_ushort2' is deprecated}}
sycl::cl_ushort2 cl_us2;
// expected-warning@+1 {{'cl_ushort3' is deprecated}}
sycl::cl_ushort3 cl_us3;
// expected-warning@+1 {{'cl_ushort4' is deprecated}}
sycl::cl_ushort4 cl_us4;
// expected-warning@+1 {{'cl_ushort8' is deprecated}}
sycl::cl_ushort8 cl_us8;
// expected-warning@+1 {{'cl_ushort16' is deprecated}}
sycl::cl_ushort16 cl_us16;

// expected-warning@+1 {{'cl_int2' is deprecated}}
sycl::cl_int2 cl_i2;
// expected-warning@+1 {{'cl_int3' is deprecated}}
sycl::cl_int3 cl_i3;
// expected-warning@+1 {{'cl_int4' is deprecated}}
sycl::cl_int4 cl_i4;
// expected-warning@+1 {{'cl_int8' is deprecated}}
sycl::cl_int8 cl_i8;
// expected-warning@+1 {{'cl_int16' is deprecated}}
sycl::cl_int16 cl_i16;

// expected-warning@+1 {{'cl_uint2' is deprecated}}
sycl::cl_uint2 cl_ui2;
// expected-warning@+1 {{'cl_uint3' is deprecated}}
sycl::cl_uint3 cl_ui3;
// expected-warning@+1 {{'cl_uint4' is deprecated}}
sycl::cl_uint4 cl_ui4;
// expected-warning@+1 {{'cl_uint8' is deprecated}}
sycl::cl_uint8 cl_ui8;
// expected-warning@+1 {{'cl_uint16' is deprecated}}
sycl::cl_uint16 cl_ui16;

// expected-warning@+1 {{'cl_long2' is deprecated}}
sycl::cl_long2 cl_l2;
// expected-warning@+1 {{'cl_long3' is deprecated}}
sycl::cl_long3 cl_l3;
// expected-warning@+1 {{'cl_long4' is deprecated}}
sycl::cl_long4 cl_l4;
// expected-warning@+1 {{'cl_long8' is deprecated}}
sycl::cl_long8 cl_l8;
// expected-warning@+1 {{'cl_long16' is deprecated}}
sycl::cl_long16 cl_l16;

// expected-warning@+1 {{'cl_ulong2' is deprecated}}
sycl::cl_ulong2 cl_ul2;
// expected-warning@+1 {{'cl_ulong3' is deprecated}}
sycl::cl_ulong3 cl_ul3;
// expected-warning@+1 {{'cl_ulong4' is deprecated}}
sycl::cl_ulong4 cl_ul4;
// expected-warning@+1 {{'cl_ulong8' is deprecated}}
sycl::cl_ulong8 cl_ul8;
// expected-warning@+1 {{'cl_ulong16' is deprecated}}
sycl::cl_ulong16 cl_ul16;

// expected-warning@+1 {{'cl_float2' is deprecated}}
sycl::cl_float2 cl_f2;
// expected-warning@+1 {{'cl_float3' is deprecated}}
sycl::cl_float3 cl_f3;
// expected-warning@+1 {{'cl_float4' is deprecated}}
sycl::cl_float4 cl_f4;
// expected-warning@+1 {{'cl_float8' is deprecated}}
sycl::cl_float8 cl_f8;
// expected-warning@+1 {{'cl_float16' is deprecated}}
sycl::cl_float16 cl_f16;

// expected-warning@+1 {{'cl_double2' is deprecated}}
sycl::cl_double2 cl_d2;
// expected-warning@+1 {{'cl_double3' is deprecated}}
sycl::cl_double3 cl_d3;
// expected-warning@+1 {{'cl_double4' is deprecated}}
sycl::cl_double4 cl_d4;
// expected-warning@+1 {{'cl_double8' is deprecated}}
sycl::cl_double8 cl_d8;
// expected-warning@+1 {{'cl_double16' is deprecated}}
sycl::cl_double16 cl_d16;

// expected-warning@+1 {{'cl_half2' is deprecated}}
sycl::cl_half2 cl_h2;
// expected-warning@+1 {{'cl_half3' is deprecated}}
sycl::cl_half3 cl_h3;
// expected-warning@+1 {{'cl_half4' is deprecated}}
sycl::cl_half4 cl_h4;
// expected-warning@+1 {{'cl_half8' is deprecated}}
sycl::cl_half8 cl_h8;
// expected-warning@+1 {{'cl_half16' is deprecated}}
sycl::cl_half16 cl_h16;
};