Merge pull request #193 from PokhodenkoSA/update-gold-2021-to-0.4.0

Update gold/2021 to 0.4.0

Author: PokhodenkoSA

.git-blame-ignore-revs

@@ -0,0 +1,4 @@
+# $ git config blame.ignoreRevsFile .git-blame-ignore-revs
+
+# Migrate code style to Black
+41ccd65e2e659aa0add0e5ab59f1a46e32cc4c46

.github/workflows/black.yml

@@ -0,0 +1,28 @@
+# This is a workflow to format Python code with black formatter
+
+name: black
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "black"
+  black:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      # Set up a Python environment for use in actions
+      - uses: actions/setup-python@v2
+
+      # Run black code formatter
+      - uses: psf/black@stable

CHANGELOG.md

@@ -1,6 +1,39 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [Unreleased]
+
+## [0.4.0] - 2020-11-04
+### Added
+- Device descriptors "max_compute_units", "max_work_item_dimensions", "max_work_item_sizes", "max_work_group_size", "max_num_sub_groups" and "aspects" for int64 atomics inside dpctl C API and inside the dpctl.SyclDevice class.
+- MemoryUSM* classes moved to `dpctl.memory` module, added support for aligned allocation, added support for `prefetch` and `mem_advise` (sychronous) methods, implemented `copy_to_host`, `copy_from_host` and `copy_from_device` methods, pickling support, and zero-copy interoperability with Python objects which implement `__sycl_usm_array_inerface__` protocol.
+- Helper scripts to generate API documentation for both C API and Python.
+
+### Fixed
+- Compiler warnings when building libDPPLSyclInterface and the Cython extensions.
+
+### Removed
+- The Legacy OpenCL interface.
+
+## [0.3.8] - 2020-10-08
+
+### Changed
+- How the initial active queue is populated inside DPPLQueueMgr.
+- dpctl.SyclQueueManager only reports the number of non-host platform.
+- dpctl.SyclQueueManager now raises an exception if DPCTL C API returns a nullptr instead of a valid Sycl queue.
+
+### Fixed
+- Several crashes in cases where an OpenCL or Level Zero platform is not available.
+  - Fix failing platform test case. (#116)
+  - Properly skip tests when no OpenCL devices are available.
+  - Add skip tests to test_sycl_usm.py
+  - Fix Gtests configuration.
+
+## [0.3.7] - 2020-10-08
+
+### Fixed
+- A crash on Windows due a Level Zero driver problem. Each device was getting enumerated twice. To handle the issue, we added a temporary fix to use only first device for each device type and backend (#118).
+
 ## [0.3.6] - 2020-10-06
 ### Added
 - Changelog was added for dpctl.

CONTRIBUTING.md

@@ -1 +1,10 @@
-Coming soon
+# Python code style
+
+## black
+
+We use [black](https://black.readthedocs.io/en/stable/) code formatter.
+
+- Revision: `20.8b1` or branch `stable`.
+- See configuration in `pyproject.toml`.
+
+Run before each commit: `black .`

README.md

@@ -1,7 +1,8 @@
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
 What?
 ====
-A lightweight Python package exposing a subset of OpenCL and SYCL
-functionalities.
+A lightweight Python package exposing a subset of SYCL functionalities.
 
 Requirements
 ============

backends/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.3.2 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.10 FATAL_ERROR)
 project("dpCtl - A lightweight SYCL wrapper for Python")
 
 # The function checks is DPCPP_ROOT is valid and points to a dpcpp installation
@@ -13,7 +13,7 @@ function (check_for_dpcpp)
         set (dpcpp_cmd "${DPCPP_ROOT}/bin/dpcpp")
         set (dpcpp_arg "--version")
     elseif(UNIX)
-        set (dpcpp_cmd "dpcpp")
+        set (dpcpp_cmd "${DPCPP_ROOT}/bin/dpcpp")
         set (dpcpp_arg "--version")
     else()
         message(FATAL_ERROR "Unsupported system.")
@@ -38,28 +38,8 @@ function (check_for_dpcpp)
     endif()
 endfunction()
 
-function (check_for_numpy_inc)
-    string(COMPARE EQUAL "${NUMPY_INCLUDE_DIR}" "" no_numpy_inc)
-    if(${no_dpcpp_root})
-        message(FATAL_ERROR "Set the NUMPY_INCLUDE_DIR argument providing the \
-                             path to NumPy Headers.")
-    else()
-        message(STATUS "NUMPY_INCLUDE_DIR: ${NUMPY_INCLUDE_DIR}")
-    endif()
-
-    string(COMPARE EQUAL "${PYTHON_INCLUDE_DIR}" "" no_python_inc)
-    if(${no_dpcpp_root})
-        message(FATAL_ERROR "Set the PYTHON_INCLUDE_DIR argument providing the \
-                             path to Python Headers.")
-    else()
-        message(STATUS "PYTHON_INCLUDE_DIR: ${PYTHON_INCLUDE_DIR}")
-    endif()
-endfunction()
-
 # Check for dpcpp in the specified DPCPP_ROOT
 check_for_dpcpp()
-# Check if the locations of Numpy and Python headers were provided
-check_for_numpy_inc()
 
 if(WIN32)
     set(CMAKE_CXX_COMPILER:PATH "${DPCPP_ROOT}/bin/dpcpp")
@@ -68,31 +48,22 @@ if(WIN32)
     message(STATUS "Resetting CXX compiler to: " ${CMAKE_CXX_COMPILER})
     message(STATUS "Resetting C compiler to: " ${CMAKE_C_COMPILER})
     message(STATUS "Resetting Linker to: " ${CMAKE_LINK})
-
-    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS}                                        \
-       -Wall -Wextra -Winit-self -Wuninitialized -Wmissing-declarations        \
-       -fdiagnostics-color=auto -O3                                            \
-    ")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Qstd=c++17")
-    set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -ggdb3 -DDEBUG ")
+    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_C_FLAGS "${CMAKE_C_FLAGS}                                        \
-       -Wall -Wextra -Winit-self -Wuninitialized -Wmissing-declarations        \
-       -fdiagnostics-color=auto -O3                                            \
-    ")
-    set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -ggdb3 -DDEBUG ")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++17 -fsycl")
+    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}")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${WARNING_FLAGS} ${SDL_FLAGS} -std=c++17 -fsycl")
+    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 -std=c++17 -fsycl")
 else()
     message(FATAL_ERROR "Unsupported system.")
 endif()
 
-
-set(OpenCL_INCLUDE_DIR "${DPCPP_ROOT}/include/sycl")
-set(OpenCL_LIBRARY "${DPCPP_ROOT}/lib/libOpenCL.so")
-
-message(STATUS "OpenCL_INCLUDE_DIR: ${OpenCL_INCLUDE_DIR}")
-message(STATUS "OpenCL_LIBRARY: ${OpenCL_LIBRARY}")
-
 add_library(
   DPPLSyclInterface
   SHARED
@@ -108,32 +79,11 @@ add_library(
   source/dppl_utils.cpp
 )
 
-# Install DPPLOpenCLInterface
-add_library(
-  DPPLOpenCLInterface
-  SHARED
-  source/dppl_opencl_interface.c
-)
-
 # Install DPPLSyclInterface
 target_include_directories(
   DPPLSyclInterface
   PRIVATE
   ${CMAKE_SOURCE_DIR}/include/
-  ${PYTHON_INCLUDE_DIR}
-  ${NUMPY_INCLUDE_DIR}
-)
-
-target_include_directories(
-    DPPLOpenCLInterface
-    PRIVATE
-    ${CMAKE_SOURCE_DIR}/include/
-)
-
-target_include_directories(
-    DPPLOpenCLInterface
-    PUBLIC
-    ${OpenCL_INCLUDE_DIR}
 )
 
 if(WIN32)
@@ -152,10 +102,6 @@ if(WIN32)
         PRIVATE ${DPCPP_ROOT}/lib/sycl.lib
         PRIVATE ${DPCPP_ROOT}/lib/OpenCL.lib
     )
-    target_link_libraries(
-        DPPLOpenCLInterface
-        PRIVATE ${DPCPP_ROOT}/lib/OpenCL.lib
-    )
 endif()
 
 install(
@@ -165,14 +111,6 @@ install(
   "${CMAKE_INSTALL_PREFIX}/lib/"
 )
 
-install(
-  TARGETS
-  DPPLOpenCLInterface
-  LIBRARY
-  DESTINATION
-  "${CMAKE_INSTALL_PREFIX}/lib/"
-)
-
 # Install all headers
 file(GLOB HEADERS "${CMAKE_SOURCE_DIR}/include/*.h*")
 foreach(HEADER ${HEADERS})
@@ -185,8 +123,17 @@ foreach(HEADER ${HEADERS})
   install(FILES "${HEADER}" DESTINATION include/Support)
 endforeach()
 
+option(
+    BUILD_CAPI_TESTS
+    "Build dpctl C API google tests"
+    OFF
+)
+
 # Enable to build the dpCtl backend test cases
-add_subdirectory(tests)
+if(BUILD_CAPI_TESTS)
+    add_subdirectory(tests)
+endif()
+
 
 # Todo : Add build rules for doxygen
 # maybe refer https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

backends/dbg_build.sh

@@ -8,9 +8,6 @@ INSTALL_PREFIX=`pwd`/../install
 rm -rf ${INSTALL_PREFIX}
 export ONEAPI_ROOT=/opt/intel/oneapi
 DPCPP_ROOT=${ONEAPI_ROOT}/compiler/latest/linux
-PYTHON_INC=`python -c "import distutils.sysconfig;                  \
-                        print(distutils.sysconfig.get_python_inc())"`
-NUMPY_INC=`python -c "import numpy; print(numpy.get_include())"`
 
 cmake                                                       \
     -DCMAKE_BUILD_TYPE=Debug                                \
@@ -19,12 +16,14 @@ cmake                                                       \
     -DDPCPP_ROOT=${DPCPP_ROOT}                              \
     -DCMAKE_C_COMPILER:PATH=${DPCPP_ROOT}/bin/clang         \
     -DCMAKE_CXX_COMPILER:PATH=${DPCPP_ROOT}/bin/dpcpp       \
-    -DPYTHON_INCLUDE_DIR=${PYTHON_INC}                      \
-    -DNUMPY_INCLUDE_DIR=${NUMPY_INC}                        \
-    -DGTEST_INCLUDE_DIR=${CONDA_PREFIX}/include/            \
-    -DGTEST_LIB_DIR=${CONDA_PREFIX}/lib                     \
+    -DBUILD_CAPI_TESTS=ON                                   \
     ..
 
 make V=1 -n -j 4 && make check && make install
 
+# For more verbose tests use:
+# cd tests
+# ctest -V --progress --output-on-failure -j 4
+# cd ..
+
 popd

backends/include/Support/CBindingWrapping.h

@@ -23,23 +23,34 @@
 ///
 //===----------------------------------------------------------------------===//
 
- #pragma once
+#pragma once
 
- #define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)     \
-   inline ty *unwrap(ref P) {                            \
-     return reinterpret_cast<ty*>(P);                    \
-   }                                                     \
-                                                         \
-   inline ref wrap(const ty *P) {                        \
-     return reinterpret_cast<ref>(const_cast<ty*>(P));   \
-   }
+/*!
+    @brief Creates two convenience functions to reinterpret_cast an opaque
+    pointer to a pointer to a Sycl type and vice-versa.
+*/
+#define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)                            \
+    __attribute__((unused)) inline ty *unwrap(ref P)                           \
+    {                                                                          \
+        return reinterpret_cast<ty*>(P);                                       \
+    }                                                                          \
+                                                                               \
+    __attribute__((unused)) inline ref wrap(const ty *P)                       \
+    {                                                                          \
+            return reinterpret_cast<ref>(const_cast<ty*>(P));                  \
+    }
 
- #define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref)     \
-   DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)           \
-                                                         \
-   template<typename T>                                  \
-   inline T *unwrap(ref P) {                             \
-     T *Q = (T*)unwrap(P);                               \
-     assert(Q && "Invalid cast!");                       \
-     return Q;                                           \
-   }
+/*!
+    @brief Add an overloaded unwrap to assert that a pointer can be legally
+    cast. @see DEFINE_SIMPLE_CONVERSION_FUNCTIONS()
+*/
+#define DEFINE_STDCXX_CONVERSION_FUNCTIONS(ty, ref)                            \
+    DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)                                \
+                                                                               \
+    template<typename T>                                                       \
+    __attribute__((unused)) inline T *unwrap(ref P)                            \
+    {                                                                          \
+        T *Q = (T*)unwrap(P);                                                  \
+        assert(Q && "Invalid cast!");                                          \
+        return Q;                                                              \
+    }

backends/include/dppl_data_types.h

@@ -76,17 +76,30 @@ typedef signed int ssize_t;
 
 #endif /* _MSC_VER */
 
-/* Set defaults for constants which we cannot find. */
+/*!
+    @brief Represents tha largest possible value of a 64 bit signed integer.
+*/
 #if !defined(INT64_MAX)
 # define INT64_MAX 9223372036854775807LL
 #endif
+
+/*!
+    @brief Represents tha smallest possible value of a 64 bit signed integer.
+*/
 #if !defined(INT64_MIN)
 # define INT64_MIN ((-INT64_MAX)-1)
 #endif
+
+/*!
+    @brief Represents tha largest possible value of a 64bit unsigned integer.
+*/
 #if !defined(UINT64_MAX)
 # define UINT64_MAX 0xffffffffffffffffULL
 #endif
 
+/*!
+    @brief Represents a positive expression of type float.
+*/
 #ifndef HUGE_VALF
 #define HUGE_VALF (float)HUGE_VAL
 #endif