[SYCL] Add device::get_info<info::device::aspects> specialisation (#7937)

Specialised function to get a vector of the complete list of supported
aspects for the current device, as per [Table 25 of the
spec](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#_device_information_descriptors).

Initial implementation uses the list of aspects, inserts them into an
initial vector with a macro, and tests each using the existing `::has()`
functionality, removing them form the list if not applicable, returning
only what is supported on the device. Thought this would reduce code
duplication and could reuse the aspect definition list file. If this
isn't appropriate, please do suggest alternatives.

The current test works but if it needs further development, do let me
know.

Author: Andrew Lamzed-Short

sycl/include/sycl/detail/info_desc_helpers.hpp

@@ -8,6 +8,7 @@
 
 #pragma once
 
+#include <sycl/aspects.hpp>
 #include <sycl/detail/pi.hpp>
 #include <sycl/info/info_desc.hpp>
 

sycl/include/sycl/device.hpp

@@ -35,6 +35,8 @@ class device_impl;
 auto getDeviceComparisonLambda();
 } // namespace detail
 
+enum class aspect;
+
 namespace ext::oneapi {
 // Forward declaration
 class filter_selector;

sycl/include/sycl/info/device_traits.def

@@ -167,6 +167,7 @@ __SYCL_PARAM_TRAITS_SPEC(device, partition_type_affinity_domain,
 // Has custom specialization. 
 __SYCL_PARAM_TRAITS_SPEC_SPECIALIZED(device, parent_device, sycl::device,
                          PI_DEVICE_INFO_PARENT_DEVICE)
+__SYCL_PARAM_TRAITS_SPEC_SPECIALIZED(device, aspects, std::vector<sycl::aspect>, 0)
 
 // Extensions/deprecated
 __SYCL_PARAM_TRAITS_SPEC(device, atomic64, bool, PI_DEVICE_INFO_ATOMIC_64)

sycl/include/sycl/info/device_traits_deprecated.def

@@ -12,8 +12,6 @@ __SYCL_PARAM_TRAITS_DEPRECATED(is_linker_available, "deprecated in SYCL 2020, us
 __SYCL_PARAM_TRAITS_DEPRECATED(queue_profiling, "deprecated in SYCL 2020, use device::has(aspect::queue_profiling) instead")
 __SYCL_PARAM_TRAITS_DEPRECATED(built_in_kernels,"deprecated in SYCL 2020, use info::device::built_in_kernel_ids instead")
 __SYCL_PARAM_TRAITS_DEPRECATED(profile,"deprecated in SYCL 2020")
-// TODO Despite giving this deprecation warning, we're still yet to implement
-// info::device::aspects.
 __SYCL_PARAM_TRAITS_DEPRECATED(extensions,"deprecated in SYCL 2020, use info::device::aspects instead")
 __SYCL_PARAM_TRAITS_DEPRECATED(printf_buffer_size,"deprecated in SYCL 2020")
 __SYCL_PARAM_TRAITS_DEPRECATED(preferred_interop_user_sync,"deprecated in SYCL 2020")

sycl/include/sycl/info/info_desc.hpp

@@ -8,6 +8,7 @@
 
 #pragma once
 
+#include <sycl/aspects.hpp>
 #include <sycl/detail/common.hpp>
 #include <sycl/detail/pi.hpp>
 #include <sycl/id.hpp>

sycl/source/device.cpp

@@ -15,6 +15,8 @@
 #include <sycl/device_selector.hpp>
 #include <sycl/info/info_desc.hpp>
 
+#include <algorithm>
+
 namespace sycl {
 __SYCL_INLINE_VER_NAMESPACE(_V1) {
 namespace detail {
@@ -150,6 +152,31 @@ __SYCL_EXPORT device device::get_info<info::device::parent_device>() const {
     return impl->template get_info<info::device::parent_device>();
 }
 
+template <>
+__SYCL_EXPORT std::vector<sycl::aspect>
+device::get_info<info::device::aspects>() const {
+  std::vector<sycl::aspect> DeviceAspects{
+#define __SYCL_ASPECT(ASPECT, ID) aspect::ASPECT,
+#include <sycl/info/aspects.def>
+#undef __SYCL_ASPECT
+  };
+
+  auto UnsupportedAspects = std::remove_if(
+      DeviceAspects.begin(), DeviceAspects.end(), [&](aspect Aspect) {
+        try {
+          return !impl->has(Aspect);
+        } catch (const runtime_error &ex) {
+          if (ex.get_cl_code() == PI_ERROR_INVALID_DEVICE)
+            return true;
+          throw;
+        }
+      });
+
+  DeviceAspects.erase(UnsupportedAspects, DeviceAspects.end());
+
+  return DeviceAspects;
+}
+
 #define __SYCL_PARAM_TRAITS_SPEC(DescType, Desc, ReturnT, PiCode)              \
   template __SYCL_EXPORT ReturnT device::get_info<info::device::Desc>() const;
 

sycl/test/abi/sycl_symbols_linux.dump

@@ -4323,6 +4323,7 @@ _ZNK4sycl3_V16device8get_infoINS0_4info6device7versionEEENS0_6detail19is_device_
 _ZNK4sycl3_V16device8get_infoINS0_4info6device8atomic64EEENS0_6detail19is_device_info_descIT_E11return_typeEv
 _ZNK4sycl3_V16device8get_infoINS0_4info6device8platformEEENS0_6detail19is_device_info_descIT_E11return_typeEv
 _ZNK4sycl3_V16device8get_infoINS0_4info6device9vendor_idEEENS0_6detail19is_device_info_descIT_E11return_typeEv
+_ZNK4sycl3_V16device8get_infoINS0_4info6device7aspectsEEENS0_6detail19is_device_info_descIT_E11return_typeEv
 _ZNK4sycl3_V16device9getNativeEv
 _ZNK4sycl3_V16kernel11get_backendEv
 _ZNK4sycl3_V16kernel11get_contextEv

sycl/test/abi/sycl_symbols_windows.dump

@@ -173,6 +173,7 @@
 ??$get_info@Uversion@device@info@_V1@sycl@@@device@_V1@sycl@@QEBA?AV?$basic_string@DU?$char_traits@D@std@@V?$allocator@D@2@@std@@XZ
 ??$get_info@Uversion@platform@info@_V1@sycl@@@platform@_V1@sycl@@QEBA?AV?$basic_string@DU?$char_traits@D@std@@V?$allocator@D@2@@std@@XZ
 ??$get_info@Uwork_group_size@kernel_device_specific@info@_V1@sycl@@@kernel@_V1@sycl@@QEBA_KAEBVdevice@12@@Z
+??$get_info@Uaspects@device@info@_V1@sycl@@@device@_V1@sycl@@QEBA?AV?$vector@W4aspect@_V1@sycl@@V?$allocator@W4aspect@_V1@sycl@@@std@@@std@@XZ
 ??$get_profiling_info@Ucommand_end@event_profiling@info@_V1@sycl@@@event@_V1@sycl@@QEBA_KXZ
 ??$get_profiling_info@Ucommand_start@event_profiling@info@_V1@sycl@@@event@_V1@sycl@@QEBA_KXZ
 ??$get_profiling_info@Ucommand_submit@event_profiling@info@_V1@sycl@@@event@_V1@sycl@@QEBA_KXZ

sycl/unittests/SYCL2020/CMakeLists.txt

@@ -7,5 +7,6 @@ add_sycl_unittest(SYCL2020Tests OBJECT
   KernelID.cpp
   HasExtension.cpp
   IsCompatible.cpp
+  DeviceGetInfoAspects.cpp
 )
 

sycl/unittests/SYCL2020/DeviceGetInfoAspects.cpp

@@ -0,0 +1,44 @@
+//==----- DeviceGetInfoAspects.cpp --- info::device::aspects unit test -----==//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include <sycl/sycl.hpp>
+
+#include <helpers/PiImage.hpp>
+#include <helpers/PiMock.hpp>
+
+#include <gtest/gtest.h>
+
+#include <algorithm>
+
+using namespace sycl;
+
+static bool containsAspect(const std::vector<sycl::aspect> &DeviceAspects,
+                           const aspect Aspect) {
+  return std::find(DeviceAspects.begin(), DeviceAspects.end(), Aspect) !=
+         DeviceAspects.end();
+}
+
+TEST(DeviceGetInfo, SupportedDeviceAspects) {
+  sycl::unittest::PiMock Mock;
+
+  sycl::platform Plt = Mock.getPlatform();
+  sycl::device Dev = Plt.get_devices()[0];
+
+  std::vector<sycl::aspect> DeviceAspects =
+      Dev.get_info<info::device::aspects>();
+
+  // Tests to examine aspects of default mock device, as defined in
+  // helpers/PiMockPlugin.hpp so these tests all need to be kept in sync with
+  // changes to that file.
+  EXPECT_TRUE(containsAspect(DeviceAspects, aspect::gpu));
+  EXPECT_TRUE(containsAspect(DeviceAspects, aspect::fp16));
+  EXPECT_TRUE(containsAspect(DeviceAspects, aspect::fp64));
+
+  EXPECT_FALSE(containsAspect(DeviceAspects, aspect::host));
+  EXPECT_FALSE(containsAspect(DeviceAspects, aspect::cpu));
+}