Added Cython example exercising dpctl.sycl

Author: oleksandr-pavlyk

examples/cython/use_dpctl_sycl/.gitignore

@@ -0,0 +1,2 @@
+use_dpctl_sycl/_cython_api.cpp
+*~

examples/cython/use_dpctl_sycl/README.md

@@ -0,0 +1,20 @@
+# Example illustrating use of dpctl.sycl in Cython
+
+Dpctl include `dpctl/sycl.pxd` file with incomplete definitions
+of SYCL runtime classes and conversion routines from SYCLInterface
+library opaque pointers to pointers to these SYCL classes.
+
+This files simplifies usage of SYCL routines from Python extensions
+written in Cython.
+
+## Building
+
+```bash
+python setup.py develop
+```
+
+## Testing
+
+```bash
+python -m pytest tests
+```

examples/cython/use_dpctl_sycl/setup.py

@@ -0,0 +1,49 @@
+#                      Data Parallel Control (dpctl)
+#
+# Copyright 2020-2022 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import Cython.Build
+import setuptools
+import setuptools.command.build_ext
+
+import dpctl
+
+
+class custom_build_ext(
+    setuptools.command.build_ext.build_ext, Cython.Build.build_ext
+):
+    def build_extensions(self):
+        self.compiler.set_executable("compiler_so", "icx -fsycl -fPIC")
+        self.compiler.set_executable("compiler_cxx", "icpx -fsycl -fPIC")
+        self.compiler.set_executable(
+            "linker_so",
+            "icpx -fsycl -shared -fpic -fsycl-device-code-split=per_kernel",
+        )
+        super().build_extensions()
+
+
+ext = setuptools.Extension(
+    "use_dpctl_sycl._cython_api",
+    ["./use_dpctl_sycl/_cython_api.pyx"],
+    include_dirs=[dpctl.get_include(), "./use_dpctl_sycl"],
+    language="c++",
+)
+
+setuptools.setup(
+    name="use_dpctl_sycl",
+    version="0.0.0",
+    ext_modules=[ext],
+    cmdclass={"build_ext": custom_build_ext},
+)

examples/cython/use_dpctl_sycl/tests/test_example.py

@@ -0,0 +1,48 @@
+#                      Data Parallel Control (dpctl)
+#
+# Copyright 2020-2022 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import pytest
+import use_dpctl_sycl
+
+import dpctl
+
+
+def test_device_name():
+    try:
+        d = dpctl.SyclDevice()
+    except dpctl.SyclDeviceCreationError:
+        pytest.skip("Could not create default device. Nothing to do")
+    d_n = use_dpctl_sycl.device_name(d)
+    assert d_n.decode("utf-8") == d.name
+
+
+def test_device_driver_version():
+    try:
+        d = dpctl.SyclDevice()
+    except dpctl.SyclDeviceCreationError:
+        pytest.skip("Could not create default device. Nothing to do")
+    d_dv = use_dpctl_sycl.device_driver_version(d)
+    assert d_dv.decode("utf-8") == d.driver_version
+
+
+def test_device_copy():
+    try:
+        d = dpctl.SyclDevice()
+    except dpctl.SyclDeviceCreationError:
+        pytest.skip("Could not create default device. Nothing to do")
+    d_copy = use_dpctl_sycl.device_copy(d)
+    assert d_copy == d
+    assert d_copy.addressof_ref() != d.addressof_ref()

examples/cython/use_dpctl_sycl/use_dpctl_sycl/__init__.py

@@ -0,0 +1,23 @@
+#                      Data Parallel Control (dpctl)
+#
+# Copyright 2020-2022 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from ._cython_api import device_copy, device_driver_version, device_name
+
+__all__ = [
+    "device_name",
+    "device_driver_version",
+    "device_copy",
+]

examples/cython/use_dpctl_sycl/use_dpctl_sycl/_cython_api.pyx

@@ -0,0 +1,53 @@
+#                      Data Parallel Control (dpctl)
+#
+# Copyright 2020-2022 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# distutils: language = c++
+# cython: language_level=3
+# cython: linetrace=True
+
+cimport libcpp.string
+
+cimport dpctl
+cimport dpctl.sycl
+
+
+cdef extern from "utils.hpp":
+    cdef libcpp.string.string get_device_name(dpctl.sycl.device)
+    cdef libcpp.string.string get_device_driver_version(dpctl.sycl.device)
+    cdef dpctl.sycl.device *copy_device(dpctl.sycl.device)
+
+
+def device_name(dpctl.SyclDevice dev):
+    cdef dpctl.DPCTLSyclDeviceRef d_ref = dev.get_device_ref()
+    cdef const dpctl.sycl.device *dpcpp_device = dpctl.sycl.unwrap_device(d_ref)
+
+    return get_device_name(dpcpp_device[0])
+
+
+def device_driver_version(dpctl.SyclDevice dev):
+    cdef dpctl.DPCTLSyclDeviceRef d_ref = dev.get_device_ref()
+    cdef const dpctl.sycl.device *dpcpp_device = dpctl.sycl.unwrap_device(d_ref)
+
+    return get_device_driver_version(dpcpp_device[0])
+
+
+cpdef dpctl.SyclDevice device_copy(dpctl.SyclDevice dev):
+    cdef dpctl.DPCTLSyclDeviceRef d_ref = dev.get_device_ref()
+    cdef const dpctl.sycl.device *dpcpp_device = dpctl.sycl.unwrap_device(d_ref)
+    cdef dpctl.sycl.device *copied_device = copy_device(dpcpp_device[0])
+    cdef dpctl.DPCTLSyclDeviceRef copied_d_ref = dpctl.sycl.wrap_device(copied_device)
+
+    return dpctl.SyclDevice._create(copied_d_ref)

examples/cython/use_dpctl_sycl/use_dpctl_sycl/utils.hpp

@@ -0,0 +1,20 @@
+#pragma once
+
+#include <CL/sycl.hpp>
+#include <string>
+
+std::string get_device_name(sycl::device d)
+{
+    return d.get_info<sycl::info::device::name>();
+}
+
+std::string get_device_driver_version(sycl::device d)
+{
+    return d.get_info<sycl::info::device::driver_version>();
+}
+
+sycl::device *copy_device(const sycl::device &d)
+{
+    auto copy_ptr = new sycl::device(d);
+    return copy_ptr;
+}