Move OpenCL sources from intel/llvm to UR

.github/CODEOWNERS

@@ -6,3 +6,6 @@ source/adapters/level_zero      @oneapi-src/unified-runtime-level-zero-write
 # CUDA and HIP adapters
 source/adapters/cuda            @oneapi-src/unified-runtime-cuda-write
 source/adapters/hip             @oneapi-src/unified-runtime-hip-write
+
+# OpenCL adapter
+source/adapters/opencl          @oneapi-src/unified-runtime-opencl-write

source/adapters/CMakeLists.txt

@@ -45,8 +45,5 @@ if(UR_BUILD_ADAPTER_HIP)
 endif()
 
 if(UR_BUILD_ADAPTER_OPENCL)
-    # Temporarily fetch the opencl adapter from a fork until the PR has been merged.
-    set(SYCL_ADAPTER_DIR "${CMAKE_CURRENT_BINARY_DIR}/external/opencl")
-    FetchSource(https://github.com/fabiomestre/llvm.git opencl_adapter_unofficial "sycl/plugins/unified_runtime/ur" ${SYCL_ADAPTER_DIR})
     add_subdirectory(opencl)
 endif()

source/adapters/opencl/.clang-format

@@ -0,0 +1,4 @@
+---
+Language: Cpp
+BasedOnStyle: LLVM
+...

source/adapters/opencl/CMakeLists.txt

@@ -3,37 +3,37 @@
 # See LICENSE.TXT
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-set(OPENCL_DIR "${SYCL_ADAPTER_DIR}/sycl/plugins/unified_runtime/ur/adapters/opencl" CACHE PATH "OpenCL adapter directory")
+set(OPENCL_DIR "${CMAKE_CURRENT_SOURCE_DIR}" CACHE PATH "OpenCL adapter directory")
 
 set(TARGET_NAME ur_adapter_opencl)
 
 add_ur_adapter(${TARGET_NAME}
         SHARED
-        ${OPENCL_DIR}/ur_interface_loader.cpp
-        ${OPENCL_DIR}/adapter.hpp
-        ${OPENCL_DIR}/adapter.cpp
-        ${OPENCL_DIR}/command_buffer.hpp
-        ${OPENCL_DIR}/command_buffer.cpp
-        ${OPENCL_DIR}/common.hpp
-        ${OPENCL_DIR}/common.cpp
-        ${OPENCL_DIR}/context.cpp
-        ${OPENCL_DIR}/context.hpp
-        ${OPENCL_DIR}/device.cpp
-        ${OPENCL_DIR}/device.hpp
-        ${OPENCL_DIR}/enqueue.cpp
-        ${OPENCL_DIR}/event.cpp
-        ${OPENCL_DIR}/image.cpp
-        ${OPENCL_DIR}/kernel.cpp
-        ${OPENCL_DIR}/memory.cpp
-        ${OPENCL_DIR}/platform.cpp
-        ${OPENCL_DIR}/platform.hpp
-        ${OPENCL_DIR}/program.cpp
-        ${OPENCL_DIR}/queue.cpp
-        ${OPENCL_DIR}/sampler.cpp
-        ${OPENCL_DIR}/usm.cpp
-        ${OPENCL_DIR}/usm_p2p.cpp
-        ${OPENCL_DIR}/../../ur.cpp
-        ${OPENCL_DIR}/../../ur.hpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/ur_interface_loader.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/adapter.hpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/adapter.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/command_buffer.hpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/command_buffer.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/common.hpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/common.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/context.hpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/context.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/device.hpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/device.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/enqueue.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/event.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/image.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/kernel.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/memory.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/platform.hpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/platform.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/program.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/queue.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/sampler.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/usm.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/usm_p2p.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../ur/ur.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../ur/ur.hpp
 )
 
 set_target_properties(${TARGET_NAME} PROPERTIES
@@ -53,7 +53,7 @@ message(STATUS "OpenCL_INCLUDE_DIR: ${OpenCL_INCLUDE_DIR}")
 
 # Suppress a compiler message about undefined CL_TARGET_OPENCL_VERSION.
 # Define all symbols up to OpenCL 3.0.
-target_compile_definitions(ur_adapter_opencl PRIVATE CL_TARGET_OPENCL_VERSION=300)
+target_compile_definitions(ur_adapter_opencl PRIVATE CL_TARGET_OPENCL_VERSION=300 CL_USE_DEPRECATED_OPENCL_1_2_APIS)
 
 # Make imported library global to use it within the project.
 add_library(OpenCL-ICD SHARED IMPORTED GLOBAL)
@@ -81,6 +81,6 @@ target_link_libraries(${TARGET_NAME} PRIVATE
 )
 
 target_include_directories(${TARGET_NAME} PRIVATE
-        ${OPENCL_DIR}/../../../
+        "${CMAKE_CURRENT_SOURCE_DIR}/../../"
         ${OpenCL_INCLUDE_DIR}
 )

source/adapters/opencl/adapter.cpp

@@ -0,0 +1,82 @@
+//===-------------- adapter.cpp - OpenCL Adapter ---------------------===//
+//
+// Copyright (C) 2023 Intel Corporation
+//
+// Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM
+// Exceptions. See LICENSE.TXT
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "common.hpp"
+
+struct ur_adapter_handle_t_ {
+  std::atomic<uint32_t> RefCount = 0;
+};
+
+ur_adapter_handle_t_ adapter{};
+
+UR_APIEXPORT ur_result_t UR_APICALL urInit(ur_device_init_flags_t,
+                                           ur_loader_config_handle_t) {
+  cl_ext::ExtFuncPtrCache = new cl_ext::ExtFuncPtrCacheT();
+  return UR_RESULT_SUCCESS;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urTearDown(void *) {
+  if (cl_ext::ExtFuncPtrCache) {
+    delete cl_ext::ExtFuncPtrCache;
+    cl_ext::ExtFuncPtrCache = nullptr;
+  }
+  return UR_RESULT_SUCCESS;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL
+urAdapterGet(uint32_t NumEntries, ur_adapter_handle_t *phAdapters,
+             uint32_t *pNumAdapters) {
+  if (NumEntries > 0 && phAdapters) {
+    *phAdapters = &adapter;
+  }
+
+  if (pNumAdapters) {
+    *pNumAdapters = 1;
+  }
+
+  return UR_RESULT_SUCCESS;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urAdapterRetain(ur_adapter_handle_t) {
+  ++adapter.RefCount;
+  return UR_RESULT_SUCCESS;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urAdapterRelease(ur_adapter_handle_t) {
+  --adapter.RefCount;
+  return UR_RESULT_SUCCESS;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urAdapterGetLastError(
+    ur_adapter_handle_t, const char **ppMessage, int32_t *pError) {
+  *ppMessage = cl_adapter::ErrorMessage;
+  *pError = cl_adapter::ErrorMessageCode;
+
+  return UR_RESULT_SUCCESS;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urAdapterGetInfo(ur_adapter_handle_t,
+                                                     ur_adapter_info_t propName,
+                                                     size_t propSize,
+                                                     void *pPropValue,
+                                                     size_t *pPropSizeRet) {
+  UrReturnHelper ReturnValue(propSize, pPropValue, pPropSizeRet);
+
+  switch (propName) {
+  case UR_ADAPTER_INFO_BACKEND:
+    return ReturnValue(UR_ADAPTER_BACKEND_CUDA);
+  case UR_ADAPTER_INFO_REFERENCE_COUNT:
+    return ReturnValue(adapter.RefCount.load());
+  default:
+    return UR_RESULT_ERROR_INVALID_ENUMERATION;
+  }
+
+  return UR_RESULT_SUCCESS;
+}

source/adapters/opencl/adapter.hpp

@@ -0,0 +1,13 @@
+//===-------------- adapter.hpp - OpenCL Adapter ---------------------===//
+//
+// Copyright (C) 2023 Intel Corporation
+//
+// Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM
+// Exceptions. See LICENSE.TXT
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+struct ur_adapter_handle_t_;
+
+extern ur_adapter_handle_t_ adapter;

source/adapters/opencl/command_buffer.cpp

@@ -0,0 +1,198 @@
+//===--------- command_buffer.cpp - OpenCL Adapter ---------------------===//
+//
+// Copyright (C) 2023 Intel Corporation
+//
+// Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM
+// Exceptions. See LICENSE.TXT
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "command_buffer.hpp"
+#include "common.hpp"
+
+/// Stub implementations of UR experimental feature command-buffers
+
+UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferCreateExp(
+    [[maybe_unused]] ur_context_handle_t hContext,
+    [[maybe_unused]] ur_device_handle_t hDevice,
+    [[maybe_unused]] const ur_exp_command_buffer_desc_t *pCommandBufferDesc,
+    [[maybe_unused]] ur_exp_command_buffer_handle_t *phCommandBuffer) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferRetainExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferReleaseExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferFinalizeExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendKernelLaunchExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer,
+    [[maybe_unused]] ur_kernel_handle_t hKernel,
+    [[maybe_unused]] uint32_t workDim,
+    [[maybe_unused]] const size_t *pGlobalWorkOffset,
+    [[maybe_unused]] const size_t *pGlobalWorkSize,
+    [[maybe_unused]] const size_t *pLocalWorkSize,
+    [[maybe_unused]] uint32_t numSyncPointsInWaitList,
+    [[maybe_unused]] const ur_exp_command_buffer_sync_point_t
+        *pSyncPointWaitList,
+    [[maybe_unused]] ur_exp_command_buffer_sync_point_t *pSyncPoint) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMemcpyUSMExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer,
+    [[maybe_unused]] void *pDst, [[maybe_unused]] const void *pSrc,
+    [[maybe_unused]] size_t size,
+    [[maybe_unused]] uint32_t numSyncPointsInWaitList,
+    [[maybe_unused]] const ur_exp_command_buffer_sync_point_t
+        *pSyncPointWaitList,
+    [[maybe_unused]] ur_exp_command_buffer_sync_point_t *pSyncPoint) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMembufferCopyExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer,
+    [[maybe_unused]] ur_mem_handle_t hSrcMem,
+    [[maybe_unused]] ur_mem_handle_t hDstMem, [[maybe_unused]] size_t srcOffset,
+    [[maybe_unused]] size_t dstOffset, [[maybe_unused]] size_t size,
+    [[maybe_unused]] uint32_t numSyncPointsInWaitList,
+    [[maybe_unused]] const ur_exp_command_buffer_sync_point_t
+        *pSyncPointWaitList,
+    [[maybe_unused]] ur_exp_command_buffer_sync_point_t *pSyncPoint) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferAppendMembufferCopyRectExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer,
+    [[maybe_unused]] ur_mem_handle_t hSrcMem,
+    [[maybe_unused]] ur_mem_handle_t hDstMem,
+    [[maybe_unused]] ur_rect_offset_t srcOrigin,
+    [[maybe_unused]] ur_rect_offset_t dstOrigin,
+    [[maybe_unused]] ur_rect_region_t region,
+    [[maybe_unused]] size_t srcRowPitch, [[maybe_unused]] size_t srcSlicePitch,
+    [[maybe_unused]] size_t dstRowPitch, [[maybe_unused]] size_t dstSlicePitch,
+    [[maybe_unused]] uint32_t numSyncPointsInWaitList,
+    [[maybe_unused]] const ur_exp_command_buffer_sync_point_t
+        *pSyncPointWaitList,
+    [[maybe_unused]] ur_exp_command_buffer_sync_point_t *pSyncPoint) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT
+ur_result_t UR_APICALL urCommandBufferAppendMembufferWriteExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer,
+    [[maybe_unused]] ur_mem_handle_t hBuffer, [[maybe_unused]] size_t offset,
+    [[maybe_unused]] size_t size, [[maybe_unused]] const void *pSrc,
+    [[maybe_unused]] uint32_t numSyncPointsInWaitList,
+    [[maybe_unused]] const ur_exp_command_buffer_sync_point_t
+        *pSyncPointWaitList,
+    [[maybe_unused]] ur_exp_command_buffer_sync_point_t *pSyncPoint) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT
+ur_result_t UR_APICALL urCommandBufferAppendMembufferReadExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer,
+    [[maybe_unused]] ur_mem_handle_t hBuffer, [[maybe_unused]] size_t offset,
+    [[maybe_unused]] size_t size, [[maybe_unused]] void *pDst,
+    [[maybe_unused]] uint32_t numSyncPointsInWaitList,
+    [[maybe_unused]] const ur_exp_command_buffer_sync_point_t
+        *pSyncPointWaitList,
+    [[maybe_unused]] ur_exp_command_buffer_sync_point_t *pSyncPoint) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT
+ur_result_t UR_APICALL urCommandBufferAppendMembufferWriteRectExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer,
+    [[maybe_unused]] ur_mem_handle_t hBuffer,
+    [[maybe_unused]] ur_rect_offset_t bufferOffset,
+    [[maybe_unused]] ur_rect_offset_t hostOffset,
+    [[maybe_unused]] ur_rect_region_t region,
+    [[maybe_unused]] size_t bufferRowPitch,
+    [[maybe_unused]] size_t bufferSlicePitch,
+    [[maybe_unused]] size_t hostRowPitch,
+    [[maybe_unused]] size_t hostSlicePitch, [[maybe_unused]] void *pSrc,
+    [[maybe_unused]] uint32_t numSyncPointsInWaitList,
+    [[maybe_unused]] const ur_exp_command_buffer_sync_point_t
+        *pSyncPointWaitList,
+    [[maybe_unused]] ur_exp_command_buffer_sync_point_t *pSyncPoint) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT
+ur_result_t UR_APICALL urCommandBufferAppendMembufferReadRectExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer,
+    [[maybe_unused]] ur_mem_handle_t hBuffer,
+    [[maybe_unused]] ur_rect_offset_t bufferOffset,
+    [[maybe_unused]] ur_rect_offset_t hostOffset,
+    [[maybe_unused]] ur_rect_region_t region,
+    [[maybe_unused]] size_t bufferRowPitch,
+    [[maybe_unused]] size_t bufferSlicePitch,
+    [[maybe_unused]] size_t hostRowPitch,
+    [[maybe_unused]] size_t hostSlicePitch, [[maybe_unused]] void *pDst,
+    [[maybe_unused]] uint32_t numSyncPointsInWaitList,
+    [[maybe_unused]] const ur_exp_command_buffer_sync_point_t
+        *pSyncPointWaitList,
+    [[maybe_unused]] ur_exp_command_buffer_sync_point_t *pSyncPoint) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}
+
+UR_APIEXPORT ur_result_t UR_APICALL urCommandBufferEnqueueExp(
+    [[maybe_unused]] ur_exp_command_buffer_handle_t hCommandBuffer,
+    [[maybe_unused]] ur_queue_handle_t hQueue,
+    [[maybe_unused]] uint32_t numEventsInWaitList,
+    [[maybe_unused]] const ur_event_handle_t *phEventWaitList,
+    [[maybe_unused]] ur_event_handle_t *phEvent) {
+
+  cl_adapter::die("Experimental Command-buffer feature is not "
+                  "implemented for OpenCL adapter.");
+  return UR_RESULT_ERROR_UNSUPPORTED_FEATURE;
+}