Merge pull request #458 from IntelPython/spring_cleaning

Minor fixes to setup.py, generate-docs.yaml, build_for_develop.sh, FindLLVMCov.cmake and FindLLVMProfdata.cmake.

Author: Diptorup Deb

.github/workflows/generate-docs.yml

@@ -23,14 +23,6 @@ jobs:
       - name: Install Intel OneAPI
         run: |
           sudo apt-get install intel-oneapi-dpcpp-cpp-compiler
-      - name: Install Level-Zero headers
-        run: |
-          sudo apt-get install -y gpg-agent wget
-          wget -qO - https://repositories.intel.com/graphics/intel-graphics.key |
-            sudo apt-key add -
-            sudo apt-add-repository \
-              'deb [arch=amd64] https://repositories.intel.com/graphics/ubuntu focal main'
-          sudo apt-get install level-zero level-zero-dev
       - name: Install Lua
         run: |
           sudo apt-get install liblua5.2-dev

dpctl-capi/cmake/modules/FindLLVMCov.cmake

@@ -25,43 +25,61 @@
 # LLVMCov_FOUND
 # LLVMCov_VERSION
 
-find_program(LLVMCov_EXE llvm-cov)
+# Check if a LLVM_TOOLS_HOME envvar is defined. If so, then search specifically
+# in that path or else search in default locations. The check is to allow
+# a particular LLVM_COV executable to be used when there are multiple LLVM_COV
+# versions installed in the system.
 
-# get the version of llvm-cov
-execute_process(
-    COMMAND ${LLVMCov_EXE} "--version"
-    RESULT_VARIABLE result
-    OUTPUT_VARIABLE version_string
-)
-
-# If llvm-cov is found then set the package variables
-if(${result} MATCHES "0")
-    string(REPLACE "\n" ";" VERSION_LIST "${version_string}")
-    list(GET VERSION_LIST 1 ver_line)
-    # Extract the llvm-cov version
-    string(REGEX MATCH "[0-9]+\.[0-9]+\.[0-9]+" LLVMCov_VERSION ${ver_line})
-    # Split out the version into major, minor an patch
-    string(REPLACE "." ";" VERSION_LIST1 "${LLVMCov_VERSION}")
-    list(GET VERSION_LIST1 0 LLVMCov_VERSION_MAJOR)
-    list(GET VERSION_LIST1 1 LLVMCov_VERSION_MINOR)
-    list(GET VERSION_LIST1 2 LLVMCov_VERSION_PATCH)
+if(DEFINED ENV{LLVM_TOOLS_HOME})
+    find_program(LLVMCov_EXE
+        llvm-cov
+        PATHS $ENV{LLVM_TOOLS_HOME}
+        NO_DEFAULT_PATH
+    )
+    if(${LLVMCov_EXE} STREQUAL "LLVMCov_EXE-NOTFOUND")
+        message(WARN
+            "$ENV{LLVM_TOOLS_HOME} does not have an llvm-cov executable"
+        )
+    endif()
+else()
+    find_program(LLVMCov_EXE llvm-cov)
 endif()
 
-# Check if a specific version of llvm-cov is required.
-if(LLVMCov_FIND_VERSION AND (DEFINED LLVMCov_VERSION))
-    string(COMPARE LESS_EQUAL
-        ${LLVMCov_FIND_VERSION_MAJOR}
-        ${LLVMCov_VERSION_MAJOR}
-        VERSION_MATCH
+if(NOT ${LLVMCov_EXE} STREQUAL "LLVMCov_EXE-NOTFOUND")
+    # get the version of llvm-cov
+    execute_process(
+        COMMAND ${LLVMCov_EXE} "--version"
+        RESULT_VARIABLE result
+        OUTPUT_VARIABLE version_string
     )
-    if(VERSION_MATCH)
+    # If llvm-cov is found then set the package variables
+    if(${result} MATCHES "0")
+        string(REPLACE "\n" ";" VERSION_LIST "${version_string}")
+        list(GET VERSION_LIST 1 ver_line)
+        # Extract the llvm-cov version
+        string(REGEX MATCH "[0-9]+\.[0-9]+\.[0-9]+" LLVMCov_VERSION ${ver_line})
+        # Split out the version into major, minor an patch
+        string(REPLACE "." ";" VERSION_LIST1 "${LLVMCov_VERSION}")
+        list(GET VERSION_LIST1 0 LLVMCov_VERSION_MAJOR)
+        list(GET VERSION_LIST1 1 LLVMCov_VERSION_MINOR)
+        list(GET VERSION_LIST1 2 LLVMCov_VERSION_PATCH)
+    endif()
+    # Check if a specific version of llvm-cov is required.
+    if(LLVMCov_FIND_VERSION AND (DEFINED LLVMCov_VERSION))
+        string(COMPARE LESS_EQUAL
+            ${LLVMCov_FIND_VERSION_MAJOR}
+            ${LLVMCov_VERSION_MAJOR}
+            VERSION_MATCH
+        )
+        if(VERSION_MATCH)
+            set(LLVMCov_FOUND TRUE)
+        endif()
+    else()
         set(LLVMCov_FOUND TRUE)
     endif()
-else()
-    set(LLVMCov_FOUND TRUE)
+    message(STATUS "llvm-cov ${LLVMCov_VERSION} found at ${LLVMCov_EXE}.")
 endif()
 
-
 find_package_handle_standard_args(LLVMCov DEFAULT_MSG
     LLVMCov_EXE
     LLVMCov_FOUND

dpctl-capi/cmake/modules/FindLLVMProfdata.cmake

@@ -24,7 +24,20 @@
 # LLVMProfdata_EXE The path to llvm-cov executable
 # LLVMProfdata_FOUND
 
-find_program(LLVMProfdata_EXE llvm-profdata)
+if(DEFINED ENV{LLVM_TOOLS_HOME})
+    find_program(LLVMProfdata_EXE
+        llvm-profdata
+        PATHS $ENV{LLVM_TOOLS_HOME}
+        NO_DEFAULT_PATH
+    )
+    if(${LLVMProfdata_EXE} STREQUAL "LLVMProfdata_EXE-NOTFOUND")
+        message(WARN
+            "$ENV{LLVM_TOOLS_HOME} does not have an llvm-profdata executable"
+        )
+    endif()
+else()
+    find_program(LLVMProfdata_EXE llvm-profdata)
+endif()
 
 find_package_handle_standard_args(LLVMProfdata DEFAULT_MSG
     LLVMProfdata_EXE

scripts/build_for_develop.sh

@@ -1,19 +1,6 @@
 #!/bin/bash
 set +xe
 
-# Check if level-zero headers are installed. Currently, works only for Ubuntu.
-# Check https://dgpu-docs.intel.com/technologies/level-zero.html for details
-# about what development package should be checked for different distros.
-if [ -f /etc/os-release ]; then
-    . /etc/os-release
-    if [[ "$NAME" == "Ubuntu" ]]; then
-        dpkg -s level-zero-dev
-        if [[ $? == 0 ]]; then
-            export HAS_LO_HEADERS=ON
-        fi
-    fi
-fi
-export CODE_COVERAGE=ON
 python setup.py clean --all
-python setup.py develop
+python setup.py develop --coverage=True
 pytest -q -ra --disable-warnings --cov dpctl --cov-report term-missing --pyargs dpctl -vv --cov-config=.coveragerc

setup.py

@@ -27,13 +27,10 @@
 import versioneer
 
 IS_WIN = False
-IS_MAC = False
 IS_LIN = False
 
 if "linux" in sys.platform:
     IS_LIN = True
-elif sys.platform == "darwin":
-    IS_MAC = True
 elif sys.platform in ["win32", "cygwin"]:
     IS_WIN = True
 else:
@@ -56,7 +53,7 @@ def remove_empty(li):
 
 def get_sdl_cflags():
     cflags = []
-    if IS_LIN or IS_MAC:
+    if IS_LIN:
         cflags = [
             "-fstack-protector",
             "-fPIC",
@@ -85,8 +82,6 @@ def get_sdl_ldflags():
 def get_other_cxxflags():
     if IS_LIN:
         return ["-O3", "-std=c++17"]
-    elif IS_MAC:
-        return []
     elif IS_WIN:
         # FIXME: These are specific to MSVC and we should first make sure
         # what compiler we are using.
@@ -129,19 +124,15 @@ def extensions():
 
     if IS_LIN:
         libs += ["rt", "DPCTLSyclInterface"]
-    elif IS_MAC:
-        pass
     elif IS_WIN:
         libs += ["DPCTLSyclInterface"]
 
     if IS_LIN:
         libraries = [dpctl_sycl_interface_lib]
     elif IS_WIN:
         libraries = [dpctl_sycl_interface_lib]
-    elif IS_MAC:
-        libraries = [dpctl_sycl_interface_lib]
 
-    if IS_LIN or IS_MAC:
+    if IS_LIN:
         runtime_library_dirs = ["$ORIGIN"]
     elif IS_WIN:
         runtime_library_dirs = []
@@ -309,7 +300,7 @@ def finalize_options(self):
         else:
             raise ValueError(
                 "--sycl-compiler-prefix value is invalid, use a "
-                "path to compiler intallation. To use oneAPI, use the "
+                "path to compiler installation. To use oneAPI, use the "
                 "default value, but remember to activate the compiler "
                 "environment"
             )
@@ -377,7 +368,7 @@ def finalize_options(self):
         else:
             raise ValueError(
                 "--sycl-compiler-prefix value is invalid, use a "
-                "path to compiler intallation. To use oneAPI, use the "
+                "path to compiler installation. To use oneAPI, use the "
                 "default value, but remember to activate the compiler "
                 "environment"
             )
@@ -402,7 +393,7 @@ def _get_cmdclass():
     name="dpctl",
     version=versioneer.get_version(),
     cmdclass=_get_cmdclass(),
-    description="A lightweight Python wrapper for a subset of OpenCL and SYCL.",
+    description="A lightweight Python wrapper for a subset of SYCL.",
     long_description=long_description,
     long_description_content_type="text/markdown",
     license="Apache 2.0",