Changes to build scripts to enable building dpctl with a custom DPC++.

Author: Diptorup Deb

README.md

@@ -41,19 +41,28 @@ conda install dpctl
 
 Build and Install with setuptools
 =================================
-dpCtl relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
+`dpctl` relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
 `setup.py` requires environment variable `ONEAPI_ROOT` and following packages
 installed:
 - `cython`
 - `numpy`
 - `cmake` - for building C API
 - `ninja` - only on Windows
 
-Activate DPC++ compiler:
+You need `DPC++` to build `dpctl`. If you want to build using the `DPC++` in a
+oneAPI distribution, activate DPC++ compiler as follows:
 ```bash
 export ONEAPI_ROOT=/opt/intel/oneapi
 source ${ONEAPI_ROOT}/compiler/latest/env/vars.sh
 ```
+To use a custom built `DPC++`, you need to create an environment variable called
+`DPCPP_HOME` that points to the root directory of the custom `DPC++` install
+path. Note that if you set the `DPCPP_HOME` environment variable, `setup.py`
+will ignore any oneAPI installation.
+
+```bash
+export DPCPP_HOME=PATH_TO_YOUR_CUSTOM_DPCPP
+```
 
 For install:
 ```cmd

dpctl-capi/CMakeLists.txt

@@ -36,21 +36,12 @@ configure_file(${CMAKE_SOURCE_DIR}/include/Config/dpctl_config.h.in
                ${CMAKE_SOURCE_DIR}/include/Config/dpctl_config.h)
 
 if(WIN32)
-    set(CMAKE_CXX_COMPILER:PATH "${DPCPP_ROOT}/bin/dpcpp")
-    set(CMAKE_C_COMPILER:PATH "${DPCPP_ROOT}/bin/clang-cl")
-    set(CMAKE_LINKER:PATH "${DPCPP_ROOT}/bin/lld-link")
-    message(STATUS "Resetting CXX compiler to: " ${CMAKE_CXX_COMPILER})
-    message(STATUS "Resetting C compiler to: " ${CMAKE_C_COMPILER})
-    message(STATUS "Resetting Linker to: " ${CMAKE_LINKER})
     set(WARNING_FLAGS "-Wall -Wextra -Winit-self -Wunused-function -Wuninitialized -Wmissing-declarations")
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${WARNING_FLAGS}")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${WARNING_FLAGS} -Qstd=c++17")
     set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} ${WARNING_FLAGS} -ggdb3 -DDEBUG")
     set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} ${WARNING_FLAGS} -ggdb3 -DDEBUG -Qstd=c++17")
 elseif(UNIX)
-    set(CMAKE_CXX_COMPILER:PATH "${DPCPP_ROOT}/bin/dpcpp")
-    set(CMAKE_C_COMPILER:PATH "${DPCPP_ROOT}/bin/clang")
-    set(CMAKE_LINKER:PATH "${DPCPP_ROOT}/bin/lld")
     set(SDL_FLAGS "-fstack-protector -fstack-protector-all -fpic -fPIC -D_FORTIFY_SOURCE=2 -Wformat -Wformat-security -fno-strict-overflow -fno-delete-null-pointer-checks")
     set(WARNING_FLAGS "-Wall -Wextra -Winit-self -Wunused-function -Wuninitialized -Wmissing-declarations -fdiagnostics-color=auto")
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${WARNING_FLAGS} ${SDL_FLAGS}")
@@ -156,3 +147,4 @@ endif()
 if(DPCTL_BUILD_CAPI_TESTS)
     add_subdirectory(tests)
 endif()
+

dpctl-capi/cmake/modules/FindDPCPP.cmake

@@ -34,8 +34,10 @@ include( FindPackageHandleStandardArgs )
 
 string(COMPARE EQUAL "${DPCPP_INSTALL_DIR}" "" no_dpcpp_root)
 if(${no_dpcpp_root})
-    message(STATUS "Set the DPCPP_ROOT argument providing the path to \
-                         a dpcpp installation.")
+    message(STATUS
+        "Set the DPCPP_INSTALL_DIR variable to provide a path to a dpcpp "
+        "installation."
+    )
     return()
 endif()
 

dpctl-capi/dbg_build.sh

@@ -6,16 +6,23 @@ pushd build
 
 INSTALL_PREFIX=`pwd`/../install
 rm -rf ${INSTALL_PREFIX}
-export ONEAPI_ROOT=/opt/intel/oneapi
-DPCPP_ROOT=${ONEAPI_ROOT}/compiler/latest/linux
+
+if [[ -z "${DPCPP_HOME}" ]]; then
+    ONEAPI_ROOT=/opt/intel/oneapi
+    DPCPP_ROOT=${ONEAPI_ROOT}/compiler/latest/linux
+else
+    DPCPP_ROOT=${DPCPP_HOME}
+fi
 
 cmake                                                       \
     -DCMAKE_BUILD_TYPE=Debug                                \
     -DCMAKE_INSTALL_PREFIX=${INSTALL_PREFIX}                \
     -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX}                   \
     -DDPCPP_INSTALL_DIR=${DPCPP_ROOT}                       \
     -DCMAKE_C_COMPILER:PATH=${DPCPP_ROOT}/bin/clang         \
-    -DCMAKE_CXX_COMPILER:PATH=${DPCPP_ROOT}/bin/dpcpp       \
+    -DCMAKE_CXX_COMPILER:PATH=${DPCPP_ROOT}/bin/clang++     \
+    -DCMAKE_CMAKE_LINKER:PATH=${DPCPP_ROOT}/bin/lld         \
+    -DCMAKE_CXX_FLAGS=" -fsycl "                            \
     -DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON                   \
     -DDPCTL_BUILD_CAPI_TESTS=ON                             \
     -DDPCTL_GENERATE_COVERAGE=ON                            \
@@ -32,3 +39,4 @@ make lcov-genhtml
 # cd ..
 
 popd
+

dpctl-capi/tests/CMakeLists.txt

@@ -71,3 +71,4 @@ endif()
 
 gtest_discover_tests(dpctl_c_api_tests)
 add_dependencies(check dpctl_c_api_tests)
+

scripts/build_backend.py

@@ -34,13 +34,17 @@
 else:
     assert False, sys.platform + " not supported"
 
-ONEAPI_ROOT = os.environ.get("ONEAPI_ROOT")
 CODE_COVERAGE = os.environ.get("CODE_COVERAGE")
-
-if IS_LIN:
-    DPCPP_ROOT = os.path.join(ONEAPI_ROOT, "compiler/latest/linux")
-if IS_WIN:
-    DPCPP_ROOT = os.path.join(ONEAPI_ROOT, "compiler\latest\windows")
+DPCPP_HOME = os.environ.get("DPCPP_HOME")
+if not DPCPP_HOME:
+    ONEAPI_ROOT = os.environ.get("ONEAPI_ROOT")
+    if IS_LIN:
+        DPCPP_HOME = os.path.join(ONEAPI_ROOT, "compiler/latest/linux")
+    elif IS_WIN:
+        DPCPP_HOME = os.path.join(ONEAPI_ROOT, "compiler\latest\windows")
+        print("DPCPP_HOME", DPCPP_HOME)
+    else:
+        assert False, sys.platform + " not supported"
 
 dpctl_dir = os.getcwd()
 build_cmake_dir = os.path.join(dpctl_dir, "build_cmake")
@@ -62,9 +66,11 @@
             "-DCMAKE_BUILD_TYPE=Debug",
             "-DCMAKE_INSTALL_PREFIX=" + INSTALL_PREFIX,
             "-DCMAKE_PREFIX_PATH=" + INSTALL_PREFIX,
-            "-DDPCPP_INSTALL_DIR=" + DPCPP_ROOT,
-            "-DCMAKE_C_COMPILER:PATH=" + os.path.join(DPCPP_ROOT, "bin", "clang"),
-            "-DCMAKE_CXX_COMPILER:PATH=" + os.path.join(DPCPP_ROOT, "bin", "dpcpp"),
+            "-DDPCPP_INSTALL_DIR=" + DPCPP_HOME,
+            "-DCMAKE_C_COMPILER:PATH=" + os.path.join(DPCPP_HOME, "bin", "clang"),
+            "-DCMAKE_CXX_COMPILER:PATH=" + os.path.join(DPCPP_HOME, "bin", "clang++"),
+            "-DCMAKE_LINKER:PATH= " + os.path.join(DPCPP_HOME, "bin", "lld"),
+            "-DCMAKE_CXX_FLAGS=-fsycl",
             "-DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON",
             "-DDPCTL_BUILD_CAPI_TESTS=ON",
             "-DDPCTL_GENERATE_COVERAGE=ON",
@@ -82,9 +88,11 @@
             "-DCMAKE_BUILD_TYPE=Release",
             "-DCMAKE_INSTALL_PREFIX=" + INSTALL_PREFIX,
             "-DCMAKE_PREFIX_PATH=" + INSTALL_PREFIX,
-            "-DDPCPP_INSTALL_DIR=" + DPCPP_ROOT,
-            "-DCMAKE_C_COMPILER:PATH=" + os.path.join(DPCPP_ROOT, "bin", "clang"),
-            "-DCMAKE_CXX_COMPILER:PATH=" + os.path.join(DPCPP_ROOT, "bin", "dpcpp"),
+            "-DDPCPP_INSTALL_DIR=" + DPCPP_HOME,
+            "-DCMAKE_C_COMPILER:PATH=" + os.path.join(DPCPP_HOME, "bin", "clang"),
+            "-DCMAKE_CXX_COMPILER:PATH=" + os.path.join(DPCPP_HOME, "bin", "clang++"),
+            "-DCMAKE_LINKER:PATH= " + os.path.join(DPCPP_HOME, "bin", "lld"),
+            "-DCMAKE_CXX_FLAGS=-fsycl",
             "-DDPCTL_ENABLE_LO_PROGRAM_CREATION=ON",
             backends,
         ]
@@ -104,9 +112,10 @@
         "-DCMAKE_BUILD_TYPE=Release",
         "-DCMAKE_INSTALL_PREFIX=" + INSTALL_PREFIX,
         "-DCMAKE_PREFIX_PATH=" + INSTALL_PREFIX,
-        "-DDPCPP_INSTALL_DIR=" + DPCPP_ROOT,
-        "-DCMAKE_C_COMPILER:PATH=" + os.path.join(DPCPP_ROOT, "bin", "clang-cl.exe"),
-        "-DCMAKE_CXX_COMPILER:PATH=" + os.path.join(DPCPP_ROOT, "bin", "dpcpp.exe"),
+        "-DDPCPP_INSTALL_DIR=" + DPCPP_HOME,
+        "-DCMAKE_C_COMPILER:PATH=" + os.path.join(DPCPP_HOME, "bin", "clang-cl.exe"),
+        "-DCMAKE_CXX_COMPILER:PATH=" + os.path.join(DPCPP_HOME, "bin", "dpcpp.exe"),
+        "-DCMAKE_LINKER:PATH=" + os.path.join(DPCPP_HOME, "bin", "lld-link.exe"),
         backends,
     ]
     subprocess.check_call(cmake_args, stderr=subprocess.STDOUT, shell=False)

scripts/build_for_develop.sh

@@ -1,54 +1,8 @@
 #!/bin/bash
 set +xe
-rm -rf build_cmake
-mkdir build_cmake
-pushd build_cmake
 
-INSTALL_PREFIX=`pwd`/../install
-rm -rf ${INSTALL_PREFIX}
-export ONEAPI_ROOT=/opt/intel/oneapi
-
-DPCPP_ROOT=${ONEAPI_ROOT}/compiler/latest/linux
-
-cmake                                                       \
-    -DCMAKE_BUILD_TYPE=Debug                                \
-    -DCMAKE_INSTALL_PREFIX=${INSTALL_PREFIX}                \
-    -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX}                   \
-    -DDPCPP_INSTALL_DIR=${DPCPP_ROOT}                       \
-    -DCMAKE_C_COMPILER:PATH=${DPCPP_ROOT}/bin/clang         \
-    -DCMAKE_CXX_COMPILER:PATH=${DPCPP_ROOT}/bin/dpcpp       \
-    -DDPCTL_BUILD_CAPI_TESTS=ON                             \
-    -DDPCTL_GENERATE_COVERAGE=ON                            \
-    ../dpctl-capi
-
-make V=1 -n -j 4 && make check && make install
-
-if [ $? -ne 0 ]; then
-    echo "Building of libDPCTLSyclInterface failed. Abort!"
-    exit 1
-fi
-
-# To run code coverage for dpctl-c API
-make llvm-cov
-# For more verbose tests use:
-# cd tests
-# ctest -V --progress --output-on-failure -j 4
-# cd ..
-
-popd
-cp install/lib/*.so dpctl/
-
-mkdir -p dpctl/include
-cp -r dpctl-capi/include/* dpctl/include
-
-export DPCTL_SYCL_INTERFACE_LIBDIR=dpctl
-export DPCTL_SYCL_INTERFACE_INCLDIR=dpctl/include
-
-export CC=${DPCPP_ROOT}/bin/clang
-export CXX=${DPCPP_ROOT}/bin/dpcpp
-# FIXME: How to pass this using setup.py? The fPIC flag is needed when
-# dpcpp compiles the Cython generated cpp file.
-export CFLAGS=-fPIC
+export CODE_COVERAGE=ON
 python setup.py clean --all
 python setup.py build develop
-python -m unittest -v dpctl.tests
+pytest --pyargs dpctl -vv
+

setup.py

@@ -42,18 +42,20 @@
     assert False, sys.platform + " not supported"
 
 if IS_LIN:
-    DPCPP_ROOT = os.environ["ONEAPI_ROOT"] + "/compiler/latest/linux"
     os.environ["DPCTL_SYCL_INTERFACE_LIBDIR"] = "dpctl"
     os.environ["DPCTL_SYCL_INTERFACE_INCLDIR"] = "dpctl/include"
     os.environ["CFLAGS"] = "-fPIC"
-
 elif IS_WIN:
     os.environ["DPCTL_SYCL_INTERFACE_LIBDIR"] = "dpctl"
     os.environ["DPCTL_SYCL_INTERFACE_INCLDIR"] = "dpctl\include"
+    DPCPP_HOME = os.environ.get("DPCPP_HOME")
+    if DPCPP_HOME:
+        sycl_lib = os.environ["DPCPP_HOME"] + "\lib"
+    else:
+        sycl_lib = os.environ["ONEAPI_ROOT"] + "\compiler\latest\windows\lib"
 
 dpctl_sycl_interface_lib = os.environ["DPCTL_SYCL_INTERFACE_LIBDIR"]
 dpctl_sycl_interface_include = os.environ["DPCTL_SYCL_INTERFACE_INCLDIR"]
-sycl_lib = os.environ["ONEAPI_ROOT"] + "\compiler\latest\windows\lib"
 
 
 def get_sdl_cflags():