Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace outdated SYCL_DEVICE_FILTER with ONEAPI_DEVICE_SELECTOR #484

Merged
merged 11 commits into from
Jun 3, 2024
Merged

Replace outdated SYCL_DEVICE_FILTER with ONEAPI_DEVICE_SELECTOR #484

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e629b6f
Replace SYCL_DEVICE_FILTER with ONEAPI_DEVICE_SELECTOR
nmishra31 Apr 23, 2024
84aa4bf
Merge branch 'oneapi-src:develop' into develop
nmishra31 Apr 25, 2024
31da159
Fix typo
nmishra31 Apr 30, 2024
bf56733
Change level_zero:cpu to opencl:cpu
nmishra31 May 7, 2024
16668d6
Remove all mentions of SYCL devices in documentation / comments
nmishra31 May 16, 2024
79b2871
Update README
nmishra31 May 17, 2024
620b074
Assign proper backends to CUFFT and ROCFFT
nmishra31 May 20, 2024
1c6b27b
Merge branch 'develop' of https://github.com/nmishra31/oneMKL into de…
nmishra31 May 20, 2024
3d62cf9
Change portfft backend
nmishra31 May 28, 2024
a5e59a5
Update CMakeLists.txt
nmishra31 May 30, 2024
9c1b328
Fix typo
nmishra31 May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/building_the_project.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ With the AMD rocBLAS backend:
-DHIP_TARGETS=gfx90a \ # Specify the targetted device architectures
[-DREF_BLAS_ROOT=<reference_blas_install_prefix>] # required only for testing
cmake --build .
export SYCL_DEVICE_FILTER=HIP
export ONEAPI_DEVICE_SELECTOR="hip:gpu"
ctest
cmake --install . --prefix <path_to_install_dir> # required to have full package structure
Expand Down Expand Up @@ -429,7 +429,7 @@ The following table provides details of CMake options and their default values:

.. note::
When building with clang++ for AMD backends, you must additionally set
``SYCL_DEVICE_FILTER`` to ``HIP`` and provide ``-DHIP_TARGETS`` according to
``ONEAPI_DEVICE_SELECTOR`` to ``hip:gpu`` and provide ``-DHIP_TARGETS`` according to
the targeted hardware. This backend has only been tested for the ``gfx90a``
architecture (MI210) at the time of writing.

Expand Down
64 changes: 32 additions & 32 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The example executable naming convention follows `example_<$domain>_<$routine>_<

Run-time dispatching examples with mklcpu backend
```
$ export SYCL_DEVICE_FILTER=cpu
$ export ONEAPI_DEVICE_SELECTOR="opencl:cpu"
$ ./bin/example_blas_gemm_usm

########################################################################
Expand All @@ -40,8 +40,8 @@ $ ./bin/example_blas_gemm_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
#
########################################################################

Expand Down Expand Up @@ -76,7 +76,7 @@ BLAS GEMM USM example ran OK.
```
Run-time dispatching examples with mklgpu backend
```
$ export SYCL_DEVICE_FILTER=gpu
$ export ONEAPI_DEVICE_SELECTOR="level_zero:gpu"
$ ./bin/example_blas_gemm_usm

########################################################################
Expand All @@ -93,8 +93,8 @@ $ ./bin/example_blas_gemm_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
#
########################################################################

Expand Down Expand Up @@ -188,7 +188,7 @@ BLAS GEMM USM example ran OK on MKLCPU and CUBLAS
## lapack
Run-time dispatching example with mklgpu backend:
```
$ export SYCL_DEVICE_FILTER=gpu
$ export ONEAPI_DEVICE_SELECTOR="level_zero:gpu"
$ ./bin/example_lapack_getrs_usm

########################################################################
Expand All @@ -206,8 +206,8 @@ $ ./bin/example_lapack_getrs_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
#
########################################################################

Expand Down Expand Up @@ -289,7 +289,7 @@ LAPACK GETRS USM example ran OK on MKLCPU and CUSOLVER
## rng
Run-time dispatching example with mklgpu backend:
```
$ export SYCL_DEVICE_FILTER=gpu
$ export ONEAPI_DEVICE_SELECTOR="level_zero:gpu"
$ ./bin/example_rng_uniform_usm

########################################################################
Expand All @@ -302,8 +302,8 @@ $ ./bin/example_rng_uniform_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# ONEAPI device
nmishra31 marked this conversation as resolved.
Show resolved Hide resolved
#
########################################################################

Expand Down Expand Up @@ -357,7 +357,7 @@ Random number generator example with uniform distribution ran OK on MKLCPU and C
Compile-time dispatching example with MKLGPU backend

```none
$ SYCL_DEVICE_FILTER=gpu ./bin/example_dft_complex_fwd_buffer_mklgpu
$ ONEAPI_DEVICE_SELECTOR="level_zero:gpu" ./bin/example_dft_complex_fwd_buffer_mklgpu

########################################################################
# Complex out-of-place forward transform for Buffer API's example:
Expand All @@ -370,8 +370,8 @@ $ SYCL_DEVICE_FILTER=gpu ./bin/example_dft_complex_fwd_buffer_mklgpu
#
# For Intel GPU with Intel MKLGPU backend.
#
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
########################################################################

Running DFT Complex forward out-of-place buffer example
Expand All @@ -384,7 +384,7 @@ DFT Complex USM example ran OK on MKLGPU
Runtime dispatching example with MKLGPU, cuFFT, rocFFT and portFFT backends:

```none
$ SYCL_DEVICE_FILTER=gpu ./bin/example_dft_real_fwd_usm
$ ONEAPI_DEVICE_SELECTOR="level_zero:gpu" ./bin/example_dft_real_fwd_usm

########################################################################
# DFT complex in-place forward transform with USM API example:
Expand All @@ -396,8 +396,8 @@ $ SYCL_DEVICE_FILTER=gpu ./bin/example_dft_real_fwd_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
#
########################################################################

Expand All @@ -409,7 +409,7 @@ DFT example ran OK
```

```none
$ SYCL_DEVICE_FILTER=gpu ./bin/example_dft_real_fwd_usm
$ ONEAPI_DEVICE_SELECTOR="level_zero:gpu" ./bin/example_dft_real_fwd_usm

########################################################################
# DFT complex in-place forward transform with USM API example:
Expand All @@ -421,8 +421,8 @@ $ SYCL_DEVICE_FILTER=gpu ./bin/example_dft_real_fwd_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
#
########################################################################

Expand All @@ -446,8 +446,8 @@ $ ./bin/example_dft_real_fwd_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
#
########################################################################

Expand All @@ -470,8 +470,8 @@ $ LD_LIBRARY_PATH=lib/:$LD_LIBRARY_PATH ./bin/example_dft_real_fwd_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
#
########################################################################

Expand All @@ -487,7 +487,7 @@ Unsupported Configuration:

Run-time dispatching examples with mklcpu backend
```
$ export SYCL_DEVICE_FILTER=cpu
$ export ONEAPI_DEVICE_SELECTOR="opencl:cpu"
$ ./bin/example_sparse_blas_gemv_usm

########################################################################
Expand All @@ -504,8 +504,8 @@ $ ./bin/example_sparse_blas_gemv_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
#
########################################################################

Expand All @@ -525,7 +525,7 @@ Sparse BLAS GEMV USM example ran OK.

Run-time dispatching examples with mklgpu backend
```
$ export SYCL_DEVICE_FILTER=gpu
$ export ONEAPI_DEVICE_SELECTOR="level_zero:gpu"
$ ./bin/example_sparse_blas_gemv_usm

########################################################################
Expand All @@ -542,8 +542,8 @@ $ ./bin/example_sparse_blas_gemv_usm
# Using single precision (float) data type
#
# Device will be selected during runtime.
# The environment variable SYCL_DEVICE_FILTER can be used to specify
# SYCL device
# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify
# available devices
#
########################################################################

Expand All @@ -563,7 +563,7 @@ Sparse BLAS GEMV USM example ran OK.

Compile-time dispatching example with mklcpu backend
```
$ export SYCL_DEVICE_FILTER=cpu
$ export ONEAPI_DEVICE_SELECTOR="opencl:cpu"
$ ./bin/example_sparse_blas_gemv_usm_mklcpu

########################################################################
Expand Down
14 changes: 7 additions & 7 deletions examples/blas/run_time_dispatching/level3/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,22 @@
# SPDX-License-Identifier: Apache-2.0
#===============================================================================

# NOTE: user needs to set env var SYCL_DEVICE_FILTER to use runtime example without specifying backend in CMake
# $ENV{SYCL_DEVICE_FILTER}
# NOTE: user needs to set env var ONEAPI_DEVICE_SELECTOR to use runtime example without specifying backend in CMake
# $ENV{ONEAPI_DEVICE_SELECTOR}


# Build object from all example sources
set(BLAS_RT_SOURCES "gemm_usm")

# Set up for the right backend for run-time dispatching examples
# If users build more than one backend (i.e. mklcpu and mklgpu, or mklcpu and CUDA), they may need to
# overwrite SYCL_DEVICE_FILTER in their environment to run on the desired backend
# overwrite ONEAPI_DEVICE_SELECTOR in their environment to run on the desired backend
set(DEVICE_FILTERS "")
if(ENABLE_MKLCPU_BACKEND)
list(APPEND DEVICE_FILTERS "cpu")
list(APPEND DEVICE_FILTERS "opencl:cpu")
endif()
if(ENABLE_MKLGPU_BACKEND)
list(APPEND DEVICE_FILTERS "gpu")
list(APPEND DEVICE_FILTERS "level_zero:gpu")
endif()
if(ENABLE_CUBLAS_BACKEND)
list(APPEND DEVICE_FILTERS "cuda:gpu")
Expand All @@ -41,7 +41,7 @@ if(ENABLE_ROCBLAS_BACKEND)
list(APPEND DEVICE_FILTERS "hip:gpu")
endif()

message(STATUS "SYCL_DEVICE_FILTER will be set to the following value(s): [${DEVICE_FILTERS}] for run-time dispatching examples")
message(STATUS "ONEAPI_DEVICE_SELECTOR will be set to the following value(s): [${DEVICE_FILTERS}] for run-time dispatching examples")

foreach(blas_rt_source ${BLAS_RT_SOURCES})
add_executable(example_${domain}_${blas_rt_source} ${blas_rt_source}.cpp)
Expand All @@ -68,7 +68,7 @@ foreach(blas_rt_source ${BLAS_RT_SOURCES})
add_test(NAME ${domain}/EXAMPLE/RT/${blas_rt_source}/${device_filter} COMMAND example_${domain}_${blas_rt_source})
set_property(TEST ${domain}/EXAMPLE/RT/${blas_rt_source}/${device_filter} PROPERTY
ENVIRONMENT LD_LIBRARY_PATH=${CMAKE_BINARY_DIR}/lib:$ENV{LD_LIBRARY_PATH}
ENVIRONMENT SYCL_DEVICE_FILTER=${device_filter})
ENVIRONMENT ONEAPI_DEVICE_SELECTOR=${device_filter})
endforeach(device_filter)

endforeach(blas_rt_source)
4 changes: 2 additions & 2 deletions examples/blas/run_time_dispatching/level3/gemm_usm.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,9 +198,9 @@ void print_example_banner() {
std::cout << "# Using single precision (float) data type" << std::endl;
std::cout << "# " << std::endl;
std::cout << "# Device will be selected during runtime." << std::endl;
std::cout << "# The environment variable SYCL_DEVICE_FILTER can be used to specify"
std::cout << "# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify"
<< std::endl;
std::cout << "# SYCL device" << std::endl;
std::cout << "# available devices" << std::endl;
std::cout << "# " << std::endl;
std::cout << "########################################################################"
<< std::endl;
Expand Down
4 changes: 2 additions & 2 deletions examples/dft/compile_time_dispatching/complex_fwd_buffer_mklcpu.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ void print_example_banner() {
"#\n"
"# For Intel CPU with Intel MKLCPU backend.\n"
"#\n"
"# The environment variable SYCL_DEVICE_FILTER can be used to specify\n"
"# SYCL device\n"
"# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify\n"
"# available devices\n"
"########################################################################\n"
<< std::endl;
}
Expand Down
4 changes: 2 additions & 2 deletions examples/dft/compile_time_dispatching/complex_fwd_buffer_mklgpu.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ void print_example_banner() {
"#\n"
"# For Intel GPU with Intel MKLGPU backend.\n"
"#\n"
"# The environment variable SYCL_DEVICE_FILTER can be used to specify\n"
"# SYCL device\n"
"# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify\n"
"# available devices\n"
"########################################################################\n"
<< std::endl;
}
Expand Down
10 changes: 5 additions & 5 deletions examples/dft/run_time_dispatching/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,22 @@
# SPDX-License-Identifier: Apache-2.0
#===============================================================================

# NOTE: user needs to set env var SYCL_DEVICE_FILTER to use runtime example (no need to specify backend when building with CMake)
# NOTE: user needs to set env var ONEAPI_DEVICE_SELECTOR to use runtime example (no need to specify backend when building with CMake)
include(WarningsUtils)


# Build object from all example sources
set(DFT_RT_SOURCES "")
# Set up for the right backend for run-time dispatching examples
# If users build more than one backend (i.e. mklcpu and mklgpu, or mklcpu and CUDA), they may need to
# overwrite SYCL_DEVICE_FILTER in their environment to run on the desired backend
# overwrite ONEAPI_DEVICE_SELECTOR in their environment to run on the desired backend
set(DEVICE_FILTERS "")
if(ENABLE_MKLGPU_BACKEND OR ENABLE_CUFFT_BACKEND OR ENABLE_ROCFFT_BACKEND OR ENABLE_PORTFFT_BACKEND)
list(APPEND DFT_RT_SOURCES "real_fwd_usm")
list(APPEND DEVICE_FILTERS "gpu")
list(APPEND DEVICE_FILTERS "level_zero:gpu")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am worried about this. Could you please check CUFFT and ROCFFT backends?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 1c6b27b. Testing was performed on a temporary branch and the only failures seen were already present in the base interfaces job.

endif()

message(STATUS "SYCL_DEVICE_FILTER will be set to the following value(s): [${DEVICE_FILTERS}] for run-time dispatching examples")
message(STATUS "ONEAPI_DEVICE_SELECTOR will be set to the following value(s): [${DEVICE_FILTERS}] for run-time dispatching examples")

foreach(dft_rt_sources ${DFT_RT_SOURCES})
add_executable(example_${domain}_${dft_rt_sources} ${dft_rt_sources}.cpp)
Expand Down Expand Up @@ -60,7 +60,7 @@ foreach(dft_rt_sources ${DFT_RT_SOURCES})
add_test(NAME ${domain}/EXAMPLE/RT/${dft_rt_sources}/${device_filter} COMMAND example_${domain}_${dft_rt_sources})
set_property(TEST ${domain}/EXAMPLE/RT/${dft_rt_sources}/${device_filter} PROPERTY
ENVIRONMENT LD_LIBRARY_PATH=${CMAKE_BINARY_DIR}/lib:$ENV{LD_LIBRARY_PATH}
ENVIRONMENT SYCL_DEVICE_FILTER=${device_filter})
ENVIRONMENT ONEAPI_DEVICE_SELECTOR=${device_filter})
endforeach(device_filter)

endforeach()
4 changes: 2 additions & 2 deletions examples/dft/run_time_dispatching/real_fwd_usm.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ void print_example_banner() {
"# Using single precision (float) data type\n"
"#\n"
"# Device will be selected during runtime.\n"
"# The environment variable SYCL_DEVICE_FILTER can be used to specify\n"
"# SYCL device\n"
"# The environment variable ONEAPI_DEVICE_SELECTOR can be used to specify\n"
"# available devices\n"
"#\n"
"########################################################################\n"
<< std::endl;
Expand Down
12 changes: 6 additions & 6 deletions examples/lapack/run_time_dispatching/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@
# SPDX-License-Identifier: Apache-2.0
#===============================================================================

# NOTE: user needs to set env var SYCL_DEVICE_FILTER to use runtime example without specifying backend in CMake
# NOTE: user needs to set env var ONEAPI_DEVICE_SELECTOR to use runtime example without specifying backend in CMake

# Build object from all example sources
set(LAPACK_RT_SOURCES "getrs_usm")

# Set up for the right backend for run-time dispatching examples
# If users build more than one backend (i.e. mklcpu and mklgpu, or mklcpu and CUDA), they may need to
# overwrite SYCL_DEVICE_FILTER in their environment to run on the desired backend
# overwrite ONEAPI_DEVICE_SELECTOR in their environment to run on the desired backend
set(DEVICE_FILTERS "")
if(ENABLE_MKLCPU_BACKEND)
list(APPEND DEVICE_FILTERS "cpu")
list(APPEND DEVICE_FILTERS "opencl:cpu")
endif()
if(ENABLE_MKLGPU_BACKEND)
list(APPEND DEVICE_FILTERS "gpu")
list(APPEND DEVICE_FILTERS "level_zero:gpu")
endif()
if(ENABLE_CUSOLVER_BACKEND)
list(APPEND DEVICE_FILTERS "cuda:gpu")
Expand All @@ -39,7 +39,7 @@ if(ENABLE_ROCSOLVER_BACKEND)
list(APPEND DEVICE_FILTERS "hip:gpu")
endif()

message(STATUS "SYCL_DEVICE_FILTER will be set to the following value(s): [${DEVICE_FILTERS}] for run-time dispatching examples")
message(STATUS "ONEAPI_DEVICE_SELECTOR will be set to the following value(s): [${DEVICE_FILTERS}] for run-time dispatching examples")

foreach(lapack_rt_source ${LAPACK_RT_SOURCES})
add_executable(example_${domain}_${lapack_rt_source} ${lapack_rt_source}.cpp)
Expand All @@ -66,7 +66,7 @@ foreach(lapack_rt_source ${LAPACK_RT_SOURCES})
add_test(NAME ${domain}/EXAMPLE/RT/${lapack_rt_source}/${device_filter} COMMAND example_${domain}_${lapack_rt_source})
set_property(TEST ${domain}/EXAMPLE/RT/${lapack_rt_source}/${device_filter} PROPERTY
ENVIRONMENT LD_LIBRARY_PATH=${CMAKE_BINARY_DIR}/lib:$ENV{LD_LIBRARY_PATH}
ENVIRONMENT SYCL_DEVICE_FILTER=${device_filter})
ENVIRONMENT ONEAPI_DEVICE_SELECTOR=${device_filter})
endforeach(device_filter)

endforeach(lapack_rt_source)
Loading