[SYCL] Mark deprecated aspects for removal (#22534)

fixes: #22476

---------

Co-authored-by: Nikita Kornev <nikita.kornev@intel.com>

Author: mianowski

sycl/include/sycl/info/aspects_deprecated.def

@@ -1,4 +1,7 @@
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
+// TODO: Remove this file once preview-breaking changes become the default ABI.
 __SYCL_ASPECT_DEPRECATED(host, 0, "removed in SYCL 2020, 'host' device has been removed")
 __SYCL_ASPECT_DEPRECATED(int64_base_atomics, 7, "use atomic64 instead")
 __SYCL_ASPECT_DEPRECATED(int64_extended_atomics, 8, "use atomic64 instead")
 __SYCL_ASPECT_DEPRECATED(usm_restricted_shared_allocations, 16, "deprecated in SYCL 2020")
+#endif // __INTEL_PREVIEW_BREAKING_CHANGES

sycl/source/detail/device_impl.hpp

@@ -1230,10 +1230,12 @@ class device_impl {
       return MCache.get<AspectDesc<Aspect>>();
     }
 #define CASE(ASPECT) else if constexpr (Aspect == aspect::ASPECT)
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
     CASE(host) {
       // Deprecated
       return false;
     }
+#endif // __INTEL_PREVIEW_BREAKING_CHANGES
     CASE(cpu) { return is_cpu(); }
     CASE(gpu) { return is_gpu(); }
     CASE(accelerator) { return is_accelerator(); }
@@ -1242,12 +1244,14 @@ class device_impl {
     CASE(host_debuggable) { return false; }
     CASE(fp16) { return has_extension("cl_khr_fp16"); }
     CASE(fp64) { return has_extension("cl_khr_fp64"); }
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
     CASE(int64_base_atomics) {
       return has_extension("cl_khr_int64_base_atomics");
     }
     CASE(int64_extended_atomics) {
       return has_extension("cl_khr_int64_extended_atomics");
     }
+#endif // __INTEL_PREVIEW_BREAKING_CHANGES
     CASE(atomic64) { return get_info_impl<UR_DEVICE_INFO_ATOMIC_64>(); }
     CASE(image) { return get_info<info::device::image_support>(); }
     CASE(online_compiler) {
@@ -1277,9 +1281,11 @@ class device_impl {
       return (get_info_impl<UR_DEVICE_INFO_USM_SINGLE_SHARED_SUPPORT>() &
               UR_DEVICE_USM_ACCESS_CAPABILITY_FLAG_ATOMIC_CONCURRENT_ACCESS);
     }
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
     CASE(usm_restricted_shared_allocations) {
       return get_info<info::device::usm_restricted_shared_allocations>();
     }
+#endif // __INTEL_PREVIEW_BREAKING_CHANGES
     CASE(usm_system_allocations) {
       return get_info<info::device::usm_system_allocations>();
     }
@@ -2367,9 +2373,14 @@ class device_impl {
       EagerCache<InfoInitializer>,               //
       CallOnceCache<InfoInitializer,
                     ext::oneapi::experimental::info::device::architecture>, //
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
       AspectCache<EagerCache, aspect::fp16, aspect::fp64,
                   aspect::int64_base_atomics, aspect::int64_extended_atomics,
                   aspect::ext_oneapi_atomic16>,
+#else
+      AspectCache<EagerCache, aspect::fp16, aspect::fp64,
+                  aspect::ext_oneapi_atomic16>,
+#endif // __INTEL_PREVIEW_BREAKING_CHANGES
       AspectCache<
           CallOnceCache,
           // Slow, >100ns (for baseline cached ~30..40ns):

sycl/source/device_aspect_macros_generator.py

@@ -1,27 +1,49 @@
+# !__INTEL_PREVIEW_BREAKING_CHANGES
 # This script is intended to generate "device_aspect_macros.h" from "aspects.def" and "aspects_deprecated.def".
+# else
+# This script is intended to generate "device_aspect_macros.h" from "aspects.def".
+# end !__INTEL_PREVIEW_BREAKING_CHANGES
 
 import os
 import sys
 
+
+# !__INTEL_PREVIEW_BREAKING_CHANGES
 def process_aspects(file_path, is_deprecated=False):
+    # else
+    # def process_aspects(file_path):
+    # end !__INTEL_PREVIEW_BREAKING_CHANGES
     with open(file_path, "r") as file:
         content = file.read()
     lines = content.strip().splitlines()
 
     output = ""
     for line in lines:
+        # !__INTEL_PREVIEW_BREAKING_CHANGES
+        stripped_line = line.strip()
+        if (
+            not stripped_line
+            or stripped_line.startswith("#")
+            or stripped_line.startswith("//")
+        ):
+            continue
         if is_deprecated:
-            aspect_macro = (
-                line.strip().replace("__SYCL_ASPECT_DEPRECATED(", "").replace(")", "")
-            )
+            aspect_macro = stripped_line.replace(
+                "__SYCL_ASPECT_DEPRECATED(", ""
+            ).replace(")", "")
             aspect_name, aspect_number, _ = aspect_macro.split(
                 ", ", 2
             )  # ignore the third parameter (message)
             output += f"// __SYCL_ASPECT_DEPRECATED({aspect_name}, {aspect_number})\n"
         else:
-            aspect_macro = line.strip().replace("__SYCL_ASPECT(", "").replace(")", "")
+            aspect_macro = stripped_line.replace("__SYCL_ASPECT(", "").replace(")", "")
             aspect_name, aspect_number = aspect_macro.split(", ")
             output += f"// __SYCL_ASPECT({aspect_name}, {aspect_number})\n"
+        # else !__INTEL_PREVIEW_BREAKING_CHANGES
+        # aspect_macro = line.strip().replace("__SYCL_ASPECT(", "").replace(")", "")
+        # aspect_name, aspect_number = aspect_macro.split(", ")
+        # output += f"// __SYCL_ASPECT({aspect_name}, {aspect_number})\n"
+        # end !__INTEL_PREVIEW_BREAKING_CHANGES
 
         output += f"#ifndef __SYCL_ALL_DEVICES_HAVE_{aspect_name}__\n"
         output += f"#define __SYCL_ALL_DEVICES_HAVE_{aspect_name}__ 0\n"
@@ -32,6 +54,7 @@ def process_aspects(file_path, is_deprecated=False):
 
     return output
 
+
 header_output = """//==------------------- device_aspect_macros.hpp - SYCL device -------------==//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
@@ -49,9 +72,15 @@ def process_aspects(file_path, is_deprecated=False):
 """
 
 include_sycl_dir = sys.argv[1]
-header_output += process_aspects(os.path.join(include_sycl_dir, "info/aspects_deprecated.def"), is_deprecated=True)
+# !__INTEL_PREVIEW_BREAKING_CHANGES
+header_output += process_aspects(
+    os.path.join(include_sycl_dir, "info/aspects_deprecated.def"), is_deprecated=True
+)
+# end !__INTEL_PREVIEW_BREAKING_CHANGES
 header_output += process_aspects(os.path.join(include_sycl_dir, "info/aspects.def"))
 
 build_include_sycl_dir = sys.argv[2]
-with open(os.path.join(build_include_sycl_dir, "device_aspect_macros.hpp"), "w") as header_file:
+with open(
+    os.path.join(build_include_sycl_dir, "device_aspect_macros.hpp"), "w"
+) as header_file:
     header_file.write(header_output)

sycl/test/basic_tests/device_config_file_aspects.cpp

@@ -24,6 +24,7 @@ int main() {
 
 #undef __SYCL_ASPECT
 
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
   auto testDeprecatedAspects =
       DeviceConfigFile::TargetTable.find("__TestDeprecatedAspectList");
   assert(testDeprecatedAspects != DeviceConfigFile::TargetTable.end());
@@ -36,6 +37,7 @@ int main() {
 #include <sycl/info/aspects_deprecated.def>
 
 #undef __SYCL_ASPECT_DEPRECATED
+#endif // __INTEL_PREVIEW_BREAKING_CHANGES
 }
 
 #undef __SYCL_ASPECT_DEPRECATED_ALIAS

sycl/test/check_device_code/device_has_func.cpp

@@ -40,7 +40,7 @@ SYCL_EXTERNAL [[sycl::device_has(sycl::aspect::cpu)]] void kernel_name_1() {
   func1();
   func2();
   func3();
-  func4<sycl::aspect::host>();
+  func4<sycl::aspect::fp64>();
   func5();
   func6();
 }
@@ -54,6 +54,6 @@ SYCL_EXTERNAL [[sycl::device_has(sycl::aspect::gpu)]] void kernel_name_2() {}
 // CHECK-ASPECTS-DAG: [[ASPECTS2]] = !{![[ASPECTFP16:[0-9]+]], ![[ASPECTGPU:[0-9]+]]}
 // CHECK-ASPECTS-DAG: [[ASPECTFP16]] = !{!"fp16", i32 5}
 // CHECK-ASPECTS-DAG: [[ASPECTGPU]] = !{!"gpu", i32 2}
-// CHECK-ASPECTS-DAG: [[ASPECTS3]] = !{![[ASPECTHOST:[0-9]+]]}
-// CHECK-ASPECTS-DAG: [[ASPECTHOST]] = !{!"host", i32 0}
+// CHECK-ASPECTS-DAG: [[ASPECTS3]] = !{![[ASPECTFP64:[0-9]+]]}
+// CHECK-ASPECTS-DAG: [[ASPECTFP64]] = !{!"fp64", i32 6}
 // CHECK-ASPECTS-DAG: [[ASPECTS4]] = !{![[ASPECTGPU]]}

sycl/test/check_device_code/device_has_kernel.cpp

@@ -43,7 +43,7 @@ class KernelFunctor {
     func1();
     func2();
     func3();
-    func4<sycl::aspect::host>();
+    func4<sycl::aspect::fp64>();
     func5();
     func6();
   }
@@ -65,6 +65,6 @@ void foo() {
 // CHECK-ASPECTS-DAG: [[ASPECTS2]] = !{![[ASPECTFP16:[0-9]+]], ![[ASPECTGPU:[0-9]+]]}
 // CHECK-ASPECTS-DAG: [[ASPECTFP16]] = !{!"fp16", i32 5}
 // CHECK-ASPECTS-DAG: [[ASPECTGPU]] = !{!"gpu", i32 2}
-// CHECK-ASPECTS-DAG: [[ASPECTS3]] = !{![[ASPECTHOST:[0-9]+]]}
-// CHECK-ASPECTS-DAG: [[ASPECTHOST]] = !{!"host", i32 0}
+// CHECK-ASPECTS-DAG: [[ASPECTS3]] = !{![[ASPECTFP64:[0-9]+]]}
+// CHECK-ASPECTS-DAG: [[ASPECTFP64]] = !{!"fp64", i32 6}
 // CHECK-ASPECTS-DAG: [[ASPECTS4]] = !{![[ASPECTGPU]]}

sycl/test/warnings/sycl_2020_deprecations.cpp

@@ -22,8 +22,10 @@ int main() {
   (void)Device.get();
   // expected-warning@+1 {{'has_extension' is deprecated: use device::has() function with aspects APIs instead}}
   (void)Device.has_extension("abc");
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
   // expected-warning@+1{{'host' is deprecated: removed in SYCL 2020, 'host' device has been removed}}
   (void)Device.has(sycl::aspect::host);
+#endif // __INTEL_PREVIEW_BREAKING_CHANGES
 
   cl_event ClEvent;
   // expected-error@+1 {{no matching constructor for initialization of 'sycl::event'}}

sycl/unittests/SYCL2020/DeviceGetInfoAspects.cpp

@@ -38,6 +38,8 @@ TEST(DeviceGetInfo, SupportedDeviceAspects) {
   EXPECT_TRUE(containsAspect(DeviceAspects, aspect::fp16));
   EXPECT_TRUE(containsAspect(DeviceAspects, aspect::fp64));
 
+#ifndef __INTEL_PREVIEW_BREAKING_CHANGES
   EXPECT_FALSE(containsAspect(DeviceAspects, aspect::host));
+#endif // __INTEL_PREVIEW_BREAKING_CHANGES
   EXPECT_FALSE(containsAspect(DeviceAspects, aspect::cpu));
 }