[SYCL][NATIVECPU] Refactor from PI plugin to UR adapter (#10523)

This PR refactors the current SYCL Native CPU Implementation as a
Unified Runtime adapter.
No new functionalities are added.

Contents of this PR:
- Native CPU implementation divided in multiple source files at
`sycl/plugins/unified_runtime/ur/adapters/native_cpu`
- Native CPU PI plugin is now implemented through the `pi2ur.hpp`
interface
- _pi_* classes have now an equivalent ur_* class
- `UR_PLATFORM_BACKEND_NATIVE_CPU` value added to
`ur2piPlatformInfoValue`

Author: Alcpz

sycl/plugins/unified_runtime/ur/adapters/native_cpu/common.cpp

@@ -0,0 +1,27 @@
+//===---------------- common.cpp - Native CPU Adapter ---------------------===//
+//
+// 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 "common.hpp"
+
+// Global variables for UR_RESULT_ADAPTER_SPECIFIC_ERROR
+// See urGetLastResult
+thread_local ur_result_t ErrorMessageCode = UR_RESULT_SUCCESS;
+thread_local char ErrorMessage[MaxMessageSize];
+
+// Utility function for setting a message and warning
+[[maybe_unused]] void setErrorMessage(const char *pMessage,
+                                      ur_result_t ErrorCode) {
+  assert(strlen(pMessage) <= MaxMessageSize);
+  strcpy(ErrorMessage, pMessage);
+  ErrorMessageCode = ErrorCode;
+}
+
+ur_result_t urGetLastResult(ur_platform_handle_t, const char **ppMessage) {
+  *ppMessage = &ErrorMessage[0];
+  return ErrorMessageCode;
+}

sycl/plugins/unified_runtime/ur/adapters/native_cpu/common.hpp

@@ -0,0 +1,42 @@
+//===----------- common.cpp - Native CPU Adapter ---------------------===//
+//
+// 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
+//
+//===-----------------------------------------------------------------===//
+
+#pragma once
+
+#include "ur/ur.hpp"
+
+constexpr size_t MaxMessageSize = 256;
+
+extern thread_local ur_result_t ErrorMessageCode;
+extern thread_local char ErrorMessage[MaxMessageSize];
+
+#define DIE_NO_IMPLEMENTATION                                                  \
+  if (PrintTrace) {                                                            \
+    std::cerr << "Not Implemented : " << __FUNCTION__                          \
+              << " - File : " << __FILE__;                                     \
+    std::cerr << " / Line : " << __LINE__ << std::endl;                        \
+  }                                                                            \
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+
+#define CONTINUE_NO_IMPLEMENTATION                                             \
+  if (PrintTrace) {                                                            \
+    std::cerr << "Warning : Not Implemented : " << __FUNCTION__                \
+              << " - File : " << __FILE__;                                     \
+    std::cerr << " / Line : " << __LINE__ << std::endl;                        \
+  }                                                                            \
+  return UR_RESULT_SUCCESS;
+
+#define CASE_UR_UNSUPPORTED(not_supported)                                     \
+  case not_supported:                                                          \
+    if (PrintTrace) {                                                          \
+      std::cerr << std::endl                                                   \
+                << "Unsupported UR case : " << #not_supported << " in "        \
+                << __FUNCTION__ << ":" << __LINE__ << "(" << __FILE__ << ")"   \
+                << std::endl;                                                  \
+    }                                                                          \
+    return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;

sycl/plugins/unified_runtime/ur/adapters/native_cpu/context.cpp

@@ -0,0 +1,107 @@
+//===--------- context.cpp - Native CPU Adapter ---------------------------===//
+//
+// 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 <memory>
+#include <tuple>
+
+#include "ur/ur.hpp"
+#include "ur_api.h"
+
+#include "common.hpp"
+#include "context.hpp"
+
+UR_APIEXPORT ur_result_t UR_APICALL
+urContextCreate(uint32_t DeviceCount, const ur_device_handle_t *phDevices,
+                const ur_context_properties_t *pProperties,
+                ur_context_handle_t *phContext) {
+  std::ignore = pProperties;
+  UR_ASSERT(phDevices, UR_RESULT_ERROR_INVALID_NULL_POINTER);
+  UR_ASSERT(phContext, UR_RESULT_ERROR_INVALID_NULL_POINTER);
+
+  assert(DeviceCount == 1);
+
+  // TODO: Proper error checking.
+  auto ctx = new ur_context_handle_t_(*phDevices);
+  *phContext = ctx;
+  return UR_RESULT_SUCCESS;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL
+urContextRetain(ur_context_handle_t hContext) {
+  std::ignore = hContext;
+  DIE_NO_IMPLEMENTATION
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL
+urContextRelease(ur_context_handle_t hContext) {
+  delete hContext;
+  return UR_RESULT_SUCCESS;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL
+urContextGetInfo(ur_context_handle_t hContext, ur_context_info_t propName,
+                 size_t propSize, void *pPropValue, size_t *pPropSizeRet) {
+
+  UR_ASSERT(hContext, UR_RESULT_ERROR_INVALID_NULL_HANDLE);
+
+  UrReturnHelper returnValue(propSize, pPropValue, pPropSizeRet);
+
+  switch (propName) {
+  case UR_CONTEXT_INFO_NUM_DEVICES:
+    return returnValue(1);
+  case UR_CONTEXT_INFO_DEVICES:
+    return returnValue(hContext->_device);
+  case UR_CONTEXT_INFO_REFERENCE_COUNT:
+    return returnValue(nullptr);
+  case UR_CONTEXT_INFO_USM_MEMCPY2D_SUPPORT:
+    return returnValue(true);
+  case UR_CONTEXT_INFO_USM_FILL2D_SUPPORT:
+    // case UR_CONTEXT_INFO_USM_MEMSET2D_SUPPORT:
+    // 2D USM operations currently not supported.
+    return returnValue(false);
+  case UR_CONTEXT_INFO_ATOMIC_MEMORY_ORDER_CAPABILITIES:
+  case UR_CONTEXT_INFO_ATOMIC_MEMORY_SCOPE_CAPABILITIES:
+  case UR_CONTEXT_INFO_ATOMIC_FENCE_ORDER_CAPABILITIES:
+  case UR_CONTEXT_INFO_ATOMIC_FENCE_SCOPE_CAPABILITIES: {
+    return UR_RESULT_ERROR_ADAPTER_SPECIFIC;
+  }
+  default:
+    return UR_RESULT_ERROR_INVALID_ENUMERATION;
+  }
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urContextGetNativeHandle(
+    ur_context_handle_t hContext, ur_native_handle_t *phNativeContext) {
+  std::ignore = hContext;
+  std::ignore = phNativeContext;
+  DIE_NO_IMPLEMENTATION
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urContextCreateWithNativeHandle(
+    ur_native_handle_t hNativeContext, uint32_t numDevices,
+    const ur_device_handle_t *phDevices,
+    const ur_context_native_properties_t *pProperties,
+    ur_context_handle_t *phContext) {
+  std::ignore = hNativeContext;
+  std::ignore = numDevices;
+  std::ignore = phDevices;
+  std::ignore = pProperties;
+  std::ignore = phContext;
+
+  DIE_NO_IMPLEMENTATION
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urContextSetExtendedDeleter(
+    ur_context_handle_t hContext, ur_context_extended_deleter_t pfnDeleter,
+    void *pUserData) {
+  std::ignore = hContext;
+  std::ignore = pfnDeleter;
+  std::ignore = pUserData;
+
+  DIE_NO_IMPLEMENTATION
+}

sycl/plugins/unified_runtime/ur/adapters/native_cpu/context.hpp

@@ -0,0 +1,19 @@
+//===--------- context.hpp - Native CPU Adapter ----------------------===//
+//
+// 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
+//
+//===-----------------------------------------------------------------===//
+
+#pragma once
+
+#include <ur_api.h>
+
+#include "device.hpp"
+
+struct ur_context_handle_t_ {
+  ur_context_handle_t_(ur_device_handle_t_ *phDevices) : _device{phDevices} {}
+
+  ur_device_handle_t _device;
+};