[SYCL][PI] Move files to libpi folder

The PI plugins could be made into an independent library,
allowing code outside the `sycl` project to use it.
The first step towards getting that
is to group all PI related files into its own directory structure.

This patch moves all the PI files into the folder `libpi`.
Includes setting up includes as `pi/piXXX`.
On the SYCL runtime side the files have been moved
from `pi.hpp` to `pi_sycl.hpp` etc.

Apart from the folder change and adjusting CMake,
there should be no change in functionality.
Tests had to be updated to set up include folders.

Author: ProGTX

sycl/CMakeLists.txt

@@ -94,20 +94,31 @@ option(SYCL_BUILD_PI_CUDA
 # Configure SYCL version macro
 set(sycl_inc_dir ${CMAKE_CURRENT_SOURCE_DIR}/include)
 set(sycl_src_dir ${CMAKE_CURRENT_SOURCE_DIR}/source)
-set(sycl_plugin_dir ${CMAKE_CURRENT_SOURCE_DIR}/plugins)
+set(sycl_plugin_dir ${CMAKE_CURRENT_SOURCE_DIR}/libpi/plugins)
 string(TIMESTAMP __SYCL_COMPILER_VERSION "%Y%m%d")
 set(version_header "${sycl_inc_dir}/CL/sycl/version.hpp")
 configure_file("${version_header}.in" "${version_header}")
 
+# Location of PI files
+set(pi_include_dir ${CMAKE_CURRENT_SOURCE_DIR}/libpi/include)
+set(pi_source_dir ${CMAKE_CURRENT_SOURCE_DIR}/libpi/src)
+
+# Copy SYCL headers from sources to build directory
+add_custom_target(pi-headers ALL
+  COMMAND ${CMAKE_COMMAND} -E copy_directory ${pi_include_dir} ${SYCL_INCLUDE_BUILD_DIR}
+  COMMENT "Copying PI headers ...")
+
 # Copy SYCL headers from sources to build directory
 add_custom_target(sycl-headers ALL
 COMMAND ${CMAKE_COMMAND} -E copy_directory ${sycl_inc_dir}/sycl ${SYCL_INCLUDE_BUILD_DIR}/sycl
 COMMAND ${CMAKE_COMMAND} -E copy_directory ${sycl_inc_dir}/CL ${SYCL_INCLUDE_BUILD_DIR}/sycl/CL
 COMMENT "Copying SYCL headers ...")
+add_dependencies(sycl-headers pi-headers)
 
 # Copy SYCL headers from sources to install directory
 install(DIRECTORY "${sycl_inc_dir}/sycl" DESTINATION ${SYCL_INCLUDE_DEPLOY_DIR} COMPONENT sycl-headers)
 install(DIRECTORY "${sycl_inc_dir}/CL" DESTINATION ${SYCL_INCLUDE_DEPLOY_DIR}/sycl COMPONENT sycl-headers)
+install(DIRECTORY "${pi_include_dir}/." DESTINATION ${SYCL_INCLUDE_DEPLOY_DIR} COMPONENT sycl-headers)
 
 set(SYCL_RT_LIBS sycl)
 if (MSVC)
@@ -213,7 +224,7 @@ option(SYCL_INCLUDE_TESTS
   ${LLVM_INCLUDE_TESTS})
 
 # Plugin Library
-add_subdirectory( plugins )
+include(libpi.cmake)
 
 add_subdirectory(tools)
 

sycl/cmake/modules/AddSYCLUnitTest.cmake

@@ -34,6 +34,7 @@ macro(add_sycl_unittest test_dirname link_variant)
   target_include_directories(${test_dirname}
     PRIVATE SYSTEM
       ${sycl_inc_dir}
+      ${pi_include_dir}
       ${SYCL_SOURCE_DIR}/source/
       ${SYCL_SOURCE_DIR}/unittests/
     )
@@ -92,8 +93,10 @@ macro(add_sycl_unittest_with_device test_dirname link_variant)
   endif()
 
   if ("${link_variant}" MATCHES "OBJECT")
+    # TODO PI integration should be fixed
+    # once add_sycl_executable supports target_link_libraries
     add_sycl_executable(${test_dirname}
-      OPTIONS -nolibsycl ${COMMON_OPTS} ${LLVM_PTHREAD_LIB} ${TERMINFO_LIB}
+      OPTIONS -nolibsycl ${COMMON_OPTS} ${LLVM_PTHREAD_LIB} ${TERMINFO_LIB} -I "${pi_include_dir}"
       SOURCES ${ARGN} $<TARGET_OBJECTS:${sycl_obj_target}>
       LIBRARIES gtest_main gtest LLVMSupport LLVMTestingSupport OpenCL ${EXTRA_LIBS}
       DEPENDANTS SYCLUnitTests)

sycl/doc/PluginInterface.md

@@ -72,8 +72,8 @@ SYCL_PI_TRACE=-1 lists all PI Traces above and more debug messages.
 
 #### Plugin binary interface
 Plugins should implement all the Interface APIs required for the PI Version
-it supports. There is [pi.def](../include/CL/sycl/detail/pi.def)/
-[pi.h](../include/CL/sycl/detail/pi.h) file listing all PI API names that can be
+it supports. There is [pi.def](../libpi/include/pi/pi.def)/
+[pi.h](../libpi/include/pi/pi.h) file listing all PI API names that can be
 called by the specific version of Plugin Interface.
 It exports a function - "piPluginInit" that returns the plugin details and
 function pointer table containing the list of pointers to implemented Interface
@@ -149,7 +149,7 @@ into
 - **Interoperability API** which allows interoperability with underlying
 runtimes such as OpenCL.
 
-See [pi.h](../include/CL/sycl/detail/pi.h) header for the full list and
+See [pi.h](../include/pi/pi.h) header for the full list and
 descriptions of PI APIs.
 
 ### The Core OpenCL-based PI APIs

sycl/include/CL/sycl/backend.hpp

@@ -15,8 +15,8 @@
 #include <CL/sycl/detail/backend_traits.hpp>
 #include <CL/sycl/detail/common.hpp>
 #include <CL/sycl/detail/export.hpp>
-#include <CL/sycl/detail/pi.h>
-#include <CL/sycl/detail/pi.hpp>
+#include <pi/pi.h>
+#include <CL/sycl/detail/pi_sycl.hpp>
 #include <CL/sycl/device.hpp>
 #include <CL/sycl/event.hpp>
 #include <CL/sycl/exception.hpp>

sycl/include/CL/sycl/backend/cuda.hpp

@@ -13,6 +13,7 @@
 #include <CL/sycl/backend_types.hpp>
 #include <CL/sycl/context.hpp>
 #include <CL/sycl/detail/defines.hpp>
+#include <CL/sycl/detail/pi_sycl.hpp>
 #include <CL/sycl/device.hpp>
 #include <CL/sycl/event.hpp>
 #include <CL/sycl/queue.hpp>
@@ -58,4 +59,4 @@ struct interop<backend::cuda, accessor<DataT, Dimensions, AccessMode,
 };
 
 } // namespace sycl
-} // namespace cl
+} // __SYCL_INLINE_NAMESPACE(cl)

sycl/include/CL/sycl/detail/array.hpp

@@ -9,6 +9,8 @@
 #pragma once
 #include <CL/sycl/detail/type_traits.hpp>
 #include <CL/sycl/exception.hpp>
+#include <pi/pi.h>
+
 #include <functional>
 #include <stdexcept>
 

sycl/include/CL/sycl/detail/device_binary_image.hpp

@@ -8,7 +8,7 @@
 #pragma once
 
 #include <CL/sycl/detail/os_util.hpp>
-#include <CL/sycl/detail/pi.hpp>
+#include <CL/sycl/detail/pi_sycl.hpp>
 
 #include <memory>
 

sycl/include/CL/sycl/detail/helpers.hpp

@@ -13,7 +13,7 @@
 #include <CL/sycl/access/access.hpp>
 #include <CL/sycl/detail/common.hpp>
 #include <CL/sycl/detail/export.hpp>
-#include <CL/sycl/detail/pi.hpp>
+#include <CL/sycl/detail/pi_sycl.hpp>
 #include <CL/sycl/detail/type_traits.hpp>
 
 #include <memory>

sycl/include/CL/sycl/detail/pi_sycl.hpp

@@ -0,0 +1,12 @@
+//==---------------- pi_sycl.hpp - SYCL wrapper for PI ---------*- C++ -*---==//
+//
+// 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 <CL/sycl/detail/defines.hpp>
+#include <pi/pi.hpp>

sycl/include/CL/sycl/detail/property_list_base.hpp

@@ -11,6 +11,7 @@
 #include <CL/sycl/detail/common.hpp>
 #include <CL/sycl/detail/property_helper.hpp>
 #include <CL/sycl/detail/stl_type_traits.hpp>
+#include <pi/pi.h>
 
 #include <bitset>
 #include <memory>