[SYCL] Implement new env var SYCL_DEVICE_FILTER #2239

bso-intel · 2020-08-01T17:52:38Z

This PR implemented the new env var SYCL_DEVICE_FILTER to allow users to specify which specific device they want to use in all different device selectors. (not the scope of this PR, implemented in #2241)
This env var is also used to load only related plugins in SYCL RT. (This PR implemented only this)

SYCL_DEVICE_FILTER=backend:device_type:device#, where device_type={host,cpu,gpu,acc,*}, backend={opencl,level_zero,cuda,*}, device#={int}
All three fields are optional, but at least one entry should be present.

Device# field is a relative index in the devices returned from platform::get_device() call. Users can use a utility tool "sycl-ls" to find the relative index, too. Once Device# is specified, the program behavior may not be the same in different systems since the relative index varies in different system.

It can list any number of triples separated by commas(,). For example, SYCL_DEVICE_FILTER=cpu,level_zero:gpu,cuda:gpu:0

For convenience, we also support ‘*’ to indicate all possible options of the triple field.
For example, “SYCL_DEVICE_FILTER=opencl:*” indicates that all different device_types that supports opencl.
To request level_zero GPU + opencl CPU, “SYCL_DEVICE_FILTER=opencl:cpu,level_zero:gpu” can be used.

HOST device is always available by default no matter how SYCL_DEVICE_FILTER is set.

This env var will affect all known device selectors since this env var will limit loading only specified plugins into the SYCL RT. For example, SYCL_DEVICE_FILTER=level_zero and cpu_selector will throw an error because the CPU device is not supported by the level_zero backend. To use both CPU device and Level_Zero GPU, one can use SYCL_DEVICE_FILTER=cpu,level_zero.

This new env var takes a list of triples {device_type, backend, device_num} 1. This list means SYCL_RT will only use those specified devices. 2. This list also limits related plugins to be loaded by SYCL RT. This PR only implemented new env var and selective plugin loading (intel#2) Signed-off-by: Byoungro So <[email protected]>

Signed-off-by: Byoungro So <[email protected]>

sycl/doc/EnvironmentVariables.md

sycl/include/CL/sycl/triple.hpp

sycl/source/detail/config.hpp

sycl/test/basic_tests/select_device.cpp

sycl/source/detail/pi.cpp

sycl/test/basic_tests/select_device.cpp

sycl/include/CL/sycl/triple.hpp

sycl/source/detail/config.hpp

sycl/source/detail/pi.cpp

sycl/source/detail/config.hpp

Pennycook · 2020-08-03T14:39:17Z

I'm not a big fan of the syntax. I think the name of the environment variable should at least be changed to SYCL_DEVICE_TRIPLES if it accepts one or more triples.

keryell · 2020-08-04T09:33:36Z

OK, so it is completely unrelated with the obvious https://llvm.org/doxygen/classllvm_1_1Triple.html
But SYCL_DEVICE_TRIPLE is very unclear. Why TRIPLE is important here? Why not a user-friendly semantic name rather a syntactic one?
Also I would like to avoid a déjà vue évolution: the llvm::Triple evolved to be able to store... 4 (four) elements! :-( So, soon SYCL_DEVICE_TRIPLE might store 5 pieces of information... :-/

Signed-off-by: Byoungro So <[email protected]>

sycl/source/detail/config.hpp

sycl/include/CL/sycl/device_triple.hpp

sycl/source/device_triple.cpp

Co-authored-by: Romanov Vlad <[email protected]>

Signed-off-by: Byoungro So <[email protected]>

…into sycl-device-triple

Signed-off-by: Byoungro So <[email protected]>

sycl/test/filter_selector/select_device_cpu.cpp

sycl/test/filter_selector/select_device_acc.cpp

sycl/test/filter_selector/select_device.cpp

sycl/source/detail/config.hpp

Co-authored-by: vladimirlaz <[email protected]>

bso-intel · 2020-09-16T14:48:41Z

Hi @vladimirlaz, Did I address all your feedback?

sycl/test/filter_selector/select_device_acc.cpp

Co-authored-by: vladimirlaz <[email protected]>

sycl/source/detail/device_filter.cpp

Co-authored-by: Vyacheslav Klochkov <[email protected]>

Signed-off-by: Byoungro So <[email protected]>

v-klochkov · 2020-09-16T20:22:04Z

Changes look good to me.
Please take a look at the 1 failed LIT test - select_device_opencl.cpp

bso-intel · 2020-09-16T20:25:04Z

Changes look good to me.
Please take a look at the 1 failed LIT test - select_device_opencl.cpp

I am still looking at the failure. Somehow, after I commit your suggested code change, it does not work.
There should be a bug somewhere, but I still can't find it. I will continue looking at it.

Signed-off-by: Byoungro So <[email protected]>

bso-intel · 2020-09-17T02:08:32Z

Code owner review required
Waiting on code owner review from @kbobrovs, @pvchupin, @smaslov-intel, and/or @intel/llvm-reviewers-runtime.

Sorry, the lastest code change cancelled your approvals.
Could you approve again? Thanks.

* upstream/sycl: (405 commits) [SYCL] Implement new env var SYCL_DEVICE_FILTER (intel#2239) [Driver][SYCL] Make /MD the default for -fsycl (intel#2478) [SYCL]: basic support of contexts with multiple devices in Level-Zero (intel#2440) [SYCL] Fix LIT regression after 9dd18ca (intel#2481) [SYCL][L0] Kernel Destroy in piKernelRelease (intel#2475) [SYCL] Emit an aliased function only if it is used (intel#2430) [Driver][SYCL] Add defaultlib directive for sycl lib (intel#2464) [Driver][SYCL] Improve situations where .exe is added for AOT tools (intel#2467) [SYCL][L0]: Check Queue refcnt prior to using members in event wait/release (intel#2471) [SYCL] Unroll several loops in __init method accessor class (intel#2449) [SYCL][Doc] Add link to use pinned memory spec (intel#2463) [SYCL] Link SYCL device libraries by default. (intel#2400) Revert "[SYCL] XFAIL test blcoking pulldown" Avoid usage of deprecated "VectorType::getNumElements" (intel#737) Fix nullptr dereference (intel#741) Do not translate arbitrary precision operations without corresponding extensions (intel#714) Add Constrained Floating-Point Intrinsics support [SYCL] Take into account auxiliary cmake options for Level Zero loader [InstCombine] improve fold of pointer differences [InstCombine] add ptr difference tests; NFC ...

…e extension doc (#2239) Original commit: KhronosGroup/SPIRV-LLVM-Translator@55966ee

Add guards to InvalidNullPointerPlatform

bso-intel added 2 commits August 1, 2020 10:20

added description of SYCL_DEVICE_TRIPLE in doc

0456825

Signed-off-by: Byoungro So <[email protected]>

bso-intel requested review from kbobrovs, pvchupin, smaslov-intel and a team as code owners August 1, 2020 17:52

bso-intel added 2 commits August 1, 2020 16:18

disable windows tentatively

72634d5

Signed-off-by: Byoungro So <[email protected]>

clean up format

6ec2671

Signed-off-by: Byoungro So <[email protected]>

kbobrovs suggested changes Aug 3, 2020

View reviewed changes

romanovvlad requested changes Aug 3, 2020

View reviewed changes

Pennycook mentioned this pull request Aug 3, 2020

[SYCL][EXT] Define a new device selector that filters based on string input #2163

Closed

jbrodman mentioned this pull request Aug 3, 2020

[SYCL] Refactor HW targeted extensions into the INTEL namespace #2246

Merged

bso-intel changed the title ~~[SYCL] Implement new env var SYCL_DEVICE_TRIPLE~~ [SYCL][WIP] Implement new env var SYCL_DEVICE_TRIPLE Aug 3, 2020

bso-intel added 2 commits August 14, 2020 10:21

Merge remote-tracking branch 'upstream/sycl' into sycl-device-triple

5471b63

accmmodated feedback

6b25217

Signed-off-by: Byoungro So <[email protected]>

bso-intel changed the title ~~[SYCL][WIP] Implement new env var SYCL_DEVICE_TRIPLE~~ [SYCL][WIP] Implement new env var SYCL_DEVICE_TRIPLES Aug 14, 2020

bso-intel added 4 commits August 15, 2020 23:09

added * for a backend type

0e9c8d4

Signed-off-by: Byoungro So <[email protected]>

Merge remote-tracking branch 'upstream/sycl' into sycl-device-triple

6304163

changed the order of device triple

35937b5

Signed-off-by: Byoungro So <[email protected]>

clang-format

8e38292

Signed-off-by: Byoungro So <[email protected]>

bso-intel changed the title ~~[SYCL][WIP] Implement new env var SYCL_DEVICE_TRIPLES~~ [SYCL] Implement new env var SYCL_DEVICE_TRIPLES Aug 25, 2020

romanovvlad previously requested changes Aug 25, 2020

View reviewed changes

bso-intel and others added 6 commits August 25, 2020 10:56

Update sycl/include/CL/sycl/device_triple.hpp

779d304

Co-authored-by: Romanov Vlad <[email protected]>

Update sycl/source/device_triple.cpp

f8034c3

Co-authored-by: Romanov Vlad <[email protected]>

feedback accmmodated

da4eab2

Signed-off-by: Byoungro So <[email protected]>

Merge branch 'sycl-device-triple' of https://github.com/bso-intel/llvm …

b995852

…into sycl-device-triple

clang-format

fa1fd6e

Signed-off-by: Byoungro So <[email protected]>

moved device_triple.hpp/cpp into 'detail' namespace

230bbd4

Signed-off-by: Byoungro So <[email protected]>

vladimirlaz suggested changes Sep 16, 2020

View reviewed changes

bso-intel and others added 4 commits September 16, 2020 07:35

Update sycl/test/filter_selector/select_device_cpu.cpp

9b83eee

Co-authored-by: vladimirlaz <[email protected]>

Update sycl/test/filter_selector/select_device_acc.cpp

092673f

Co-authored-by: vladimirlaz <[email protected]>

Update sycl/test/filter_selector/select_device_acc.cpp

84a80ef

Co-authored-by: vladimirlaz <[email protected]>

Update sycl/source/detail/config.hpp

0a0cf63

Co-authored-by: vladimirlaz <[email protected]>

vladimirlaz suggested changes Sep 16, 2020

View reviewed changes

sycl/test/filter_selector/select_device_acc.cpp Outdated Show resolved Hide resolved

Update sycl/test/filter_selector/select_device_acc.cpp

dd12cba

Co-authored-by: vladimirlaz <[email protected]>

vladimirlaz previously approved these changes Sep 16, 2020

View reviewed changes

v-klochkov previously approved these changes Sep 16, 2020

View reviewed changes

v-klochkov reviewed Sep 16, 2020

View reviewed changes

sycl/source/detail/device_filter.cpp Outdated Show resolved Hide resolved

Update sycl/source/detail/device_filter.cpp

f3c6387

Co-authored-by: Vyacheslav Klochkov <[email protected]>

bso-intel dismissed stale reviews from v-klochkov and vladimirlaz via f3c6387 September 16, 2020 17:46

clang-format

4708688

Signed-off-by: Byoungro So <[email protected]>

fixed error caused in lambda

ba2c293

Signed-off-by: Byoungro So <[email protected]>

v-klochkov approved these changes Sep 17, 2020

View reviewed changes

vladimirlaz approved these changes Sep 17, 2020

View reviewed changes

pvchupin approved these changes Sep 17, 2020

View reviewed changes

pvchupin merged commit 14e227c into intel:sycl Sep 17, 2020

bso-intel deleted the sycl-device-triple branch September 22, 2020 14:52

andreyfe1 mentioned this pull request Feb 10, 2021

Replaced SYCL_DEVICE_TYPE with SYCL_DEVICE_FILTER in CMake uxlfoundation/oneDPL#114

Merged

jsji pushed a commit that referenced this pull request Nov 30, 2023

Put args order for CooperativeMatrixLoadKHR in correspondence with th…

f9266d7

…e extension doc (#2239) Original commit: KhronosGroup/SPIRV-LLVM-Translator@55966ee

Chenyang-L pushed a commit that referenced this pull request Feb 18, 2025

Merge pull request #2239 from RossBrunton/ross/invalidNullPtrPlat

19913ae

Add guards to InvalidNullPointerPlatform

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[SYCL] Implement new env var SYCL_DEVICE_FILTER #2239

[SYCL] Implement new env var SYCL_DEVICE_FILTER #2239

bso-intel commented Aug 1, 2020 •

edited

Loading

Pennycook commented Aug 3, 2020

keryell commented Aug 4, 2020

bso-intel commented Sep 16, 2020

v-klochkov commented Sep 16, 2020

bso-intel commented Sep 16, 2020

bso-intel commented Sep 17, 2020

[SYCL] Implement new env var SYCL_DEVICE_FILTER #2239

[SYCL] Implement new env var SYCL_DEVICE_FILTER #2239

Conversation

bso-intel commented Aug 1, 2020 • edited Loading

Pennycook commented Aug 3, 2020

keryell commented Aug 4, 2020

bso-intel commented Sep 16, 2020

v-klochkov commented Sep 16, 2020

bso-intel commented Sep 16, 2020

bso-intel commented Sep 17, 2020

bso-intel commented Aug 1, 2020 •

edited

Loading