[SYCL][NFC] Remove deprecated variables from LIT (#2794)

Remove use of deprecated environment variables (SYCL_BE,
SYCL_DEVICE_TYPE) from LIT framework. Use SYCL_DEVICE_FILTER instead:

 - rename CMake parameter SYCL_BE to SYCL_PLUGIN to avoid mix-up with
 deprecated environment variable;
 - update [CPU|GPU|ACC]_RUN_PLACEHOLDER to use SYCL_DEVICE_FILTER;
 - change values format used to define a backend and a device type to
match SYCL_DEVICE_FILTER requirements;
 - add BE_RUN_PLACEHOLDER to set backend only for tests which require
that;
 - add RUN_ON_HOST substitution to clearly state target device in RUN
 command.

Author: vladimirlaz

sycl/test/CMakeLists.txt

@@ -45,7 +45,7 @@ list(APPEND SYCL_DEPLOY_TEST_DEPS
 add_lit_testsuite(check-sycl-deploy "Running the SYCL regression tests"
   ${CMAKE_CURRENT_BINARY_DIR}
   ARGS ${DEPLOY_RT_TEST_ARGS}
-  PARAMS "SYCL_BE=PI_OPENCL"
+  PARAMS "SYCL_PLUGIN=opencl"
   DEPENDS ${SYCL_DEPLOY_TEST_DEPS}
   EXCLUDE_FROM_CHECK_ALL
   )
@@ -58,15 +58,15 @@ add_lit_testsuites(SYCL ${CMAKE_CURRENT_SOURCE_DIR}
 
 add_lit_testsuites(SYCL-DEPLOY ${CMAKE_CURRENT_SOURCE_DIR}
   ARGS ${DEPLOY_RT_TEST_ARGS}
-  PARAMS "SYCL_BE=PI_OPENCL"
+  PARAMS "SYCL_PLUGIN=opencl"
   DEPENDS ${SYCL_DEPLOY_TEST_DEPS}
   EXCLUDE_FROM_CHECK_ALL
   )
 
 add_lit_testsuite(check-sycl-opencl "Running the SYCL regression tests for OpenCL"
   ${CMAKE_CURRENT_BINARY_DIR}
   ARGS ${RT_TEST_ARGS}
-  PARAMS "SYCL_BE=PI_OPENCL"
+  PARAMS "SYCL_PLUGIN=opencl"
   DEPENDS ${SYCL_TEST_DEPS}
   EXCLUDE_FROM_CHECK_ALL
   )
@@ -75,7 +75,7 @@ set_target_properties(check-sycl-opencl PROPERTIES FOLDER "SYCL tests")
 add_lit_testsuite(check-sycl-level-zero "Running the SYCL regression tests for Level Zero"
   ${CMAKE_CURRENT_BINARY_DIR}
   ARGS ${RT_TEST_ARGS}
-  PARAMS "SYCL_BE=PI_LEVEL_ZERO"
+  PARAMS "SYCL_PLUGIN=level_zero"
   DEPENDS ${SYCL_TEST_DEPS}
   EXCLUDE_FROM_CHECK_ALL
   )
@@ -89,7 +89,7 @@ if(SYCL_BUILD_PI_CUDA)
   add_lit_testsuite(check-sycl-cuda "Running the SYCL regression tests for CUDA"
     ${CMAKE_CURRENT_BINARY_DIR}
     ARGS ${RT_TEST_ARGS}
-    PARAMS "SYCL_BE=PI_CUDA"
+    PARAMS "SYCL_PLUGIN=cuda"
     DEPENDS ${SYCL_TEST_DEPS}
     EXCLUDE_FROM_CHECK_ALL
   )
@@ -98,7 +98,7 @@ if(SYCL_BUILD_PI_CUDA)
   add_dependencies(check-sycl check-sycl-cuda)
 
   add_lit_testsuites(SYCL-CUDA ${CMAKE_CURRENT_SOURCE_DIR}
-    PARAMS "SYCL_BE=PI_CUDA"
+    PARAMS "SYCL_PLUGIN=cuda"
     DEPENDS ${SYCL_TEST_DEPS}
     EXCLUDE_FROM_CHECK_ALL
   )

sycl/test/Unit/lit.cfg.py

@@ -73,5 +73,5 @@ def find_shlibpath_var():
     lit_config.warning("unable to inject shared library path on '{}'"
                        .format(platform.system()))
 
-config.environment['SYCL_BE'] = lit_config.params.get('SYCL_BE', "PI_OPENCL")
-lit_config.note("Backend (SYCL_BE): {}".format(config.environment['SYCL_BE']))
+config.environment['SYCL_DEVICE_FILTER'] = lit_config.params.get('SYCL_PLUGIN', "opencl")
+lit_config.note("Backend: {}".format(config.environment['SYCL_DEVICE_FILTER']))

sycl/test/atomic_ref/accessor.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-unnamed-lambda -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/atomic_ref/add.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-unnamed-lambda -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/atomic_ref/compare_exchange.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/atomic_ref/exchange.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/atomic_ref/load.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/atomic_ref/max.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-unnamed-lambda -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/atomic_ref/min.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-unnamed-lambda -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/atomic_ref/store.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/atomic_ref/sub.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-unnamed-lambda -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/basic_tests/accessor/accessor_property_list_rt.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 

sycl/test/basic_tests/built-ins.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 // CUDA does not support printf.
 // UNSUPPORTED: cuda

sycl/test/basic_tests/context.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx %s -o %t.out -lsycl -I %sycl_include
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 //==--------------- context.cpp - SYCL context test ------------------------==//
 //

sycl/test/basic_tests/device.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx %s -o %t.out -I %sycl_include -lsycl
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 //==--------------- device.cpp - SYCL device test --------------------------==//
 //

sycl/test/basic_tests/device_selector.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_BE=%sycl_be %t.out
+// RUN: %BE_RUN_PLACEHOLDER %t.out
 //
 // Checks that no device is selected when no device of desired type is
 // available.

sycl/test/basic_tests/esimd/vadd.cpp

@@ -1,27 +1,30 @@
 // TODO ESIMD enable host device under -fsycl
 // RUN: %clangxx -I %sycl_include %s -o %t.out -lsycl
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <CL/sycl/INTEL/esimd.hpp>
 #include <iostream>
+#include <string>
 
 using namespace cl::sycl;
 
 class ESIMDSelector : public device_selector {
-  // Require GPU device unless HOST is requested in SYCL_DEVICE_TYPE env
+  // Require GPU device unless HOST is requested in SYCL_DEVICE_FILTER env
   virtual int operator()(const device &device) const {
-    if (const char *dev_type = getenv("SYCL_DEVICE_TYPE")) {
-      if (!strcmp(dev_type, "GPU"))
+    if (const char *dev_filter = getenv("SYCL_DEVICE_FILTER")) {
+      std::string filter_string(dev_filter);
+      if (filter_string.find("gpu") != std::string::npos)
         return device.is_gpu() ? 1000 : -1;
-      if (!strcmp(dev_type, "HOST"))
+      if (filter_string.find("host") != std::string::npos)
         return device.is_host() ? 1000 : -1;
-      std::cerr << "Supported 'SYCL_DEVICE_TYPE' env var values are 'GPU' and "
-                   "'HOST', '"
-                << dev_type << "' is not.\n";
+      std::cerr
+          << "Supported 'SYCL_DEVICE_FILTER' env var values are 'gpu' and "
+             "'host', '"
+          << filter_string << "' does not contain such substrings.\n";
       return -1;
     }
-    // If "SYCL_DEVICE_TYPE" not defined, only allow gpu device
+    // If "SYCL_DEVICE_FILTER" not defined, only allow gpu device
     return device.is_gpu() ? 1000 : -1;
   }
 };

sycl/test/basic_tests/event_async_exception.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 //==---- event_async_exception.cpp - Test for event async exceptions -------==//
 //

sycl/test/basic_tests/host_image_accessor_read.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 //==---- host_image_accessor_read.cpp - SYCL host image accessor check ----==//
 //

sycl/test/basic_tests/linear-host-dev.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out | FileCheck %s
+// RUN: %RUN_ON_HOST %t.out | FileCheck %s
 
 #include <CL/sycl.hpp>
 #include <algorithm>

sycl/test/basic_tests/parallel_for_range_host.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 

sycl/test/basic_tests/property_list.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx %s -o %t.out -lsycl -I%sycl_include
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 //
 // CHECK: PASSED
 //==--------------- property_list.cpp - SYCL property list test ------------==//

sycl/test/basic_tests/reduction_ctor.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 // This performs basic checks such as reduction creation, getIdentity() method,
 // and the combine() method of the aux class 'reducer'.

sycl/test/bit_cast/bit_cast.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 

sycl/test/extensions/usm.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t1.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t1.out
+// RUN: %RUN_ON_HOST %t1.out
 
 //==---------- allocator_equal.cpp - Allocator Equality test ---------------==//
 //

sycl/test/function-pointers/fp-as-kernel-arg.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -Xclang -fsycl-allow-func-ptr -std=c++14 -fsycl %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 // FIXME: This test should use runtime early exit once correct check for
 // corresponding extension is implemented
 

sycl/test/function-pointers/pass-fp-through-buffer.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -Xclang -fsycl-allow-func-ptr -std=c++14 -fsycl %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 // FIXME: This test should use runtime early exit once correct check for
 // corresponding extension is implemented
 

sycl/test/functor/functor_inheritance.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple -o %t.out %s
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <cassert>

sycl/test/functor/kernel_functor.cpp

@@ -1,6 +1,6 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple -o %t.out %s
 // RUN: cd %T
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 //==--- kernel_functor.cpp - Functors as SYCL kernel test ------------------==//
 //

sycl/test/kernel_param/array-kernel-param-nested-run.cpp

@@ -1,7 +1,7 @@
 // This test checks kernel execution with array parameters inside structs.
 
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <iostream>

sycl/test/kernel_param/array-kernel-param-run.cpp

@@ -1,7 +1,7 @@
 // This test checks kernel execution with array kernel parameters.
 
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <iostream>

sycl/test/kernel_param/non-standard-layout.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 

sycl/test/kernel_param/struct_kernel_param.cpp

@@ -1,5 +1,5 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 //==-struct_kernel_param.cpp-Checks passing structs as kernel params--------==//
 //

sycl/test/kernel_param/union_kernel_param.cpp

@@ -1,7 +1,7 @@
 // This test checks kernel execution with union type as kernel parameters.
 
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 
 #include <CL/sycl.hpp>
 #include <cstdio>

sycl/test/lit.cfg.py

@@ -75,9 +75,11 @@
 
 llvm_config.add_tool_substitutions(['llvm-spirv'], [config.sycl_tools_dir])
 
-backend=lit_config.params.get('SYCL_BE', "PI_OPENCL")
-lit_config.note("Backend (SYCL_BE): {}".format(backend))
-config.substitutions.append( ('%sycl_be', backend) )
+backend=lit_config.params.get('SYCL_PLUGIN', "opencl")
+lit_config.note("Backend: {}".format(backend))
+config.substitutions.append( ('%sycl_be', { 'opencl': 'PI_OPENCL',  'cuda': 'PI_CUDA', 'level_zero': 'PI_LEVEL_ZERO'}[backend]) )
+config.substitutions.append( ('%BE_RUN_PLACEHOLDER', "env SYCL_DEVICE_FILTER={SYCL_PLUGIN} ".format(SYCL_PLUGIN=backend)) )
+config.substitutions.append( ('%RUN_ON_HOST', "env SYCL_DEVICE_FILTER=host ") )
 
 get_device_count_by_type_path = os.path.join(config.llvm_tools_dir, "get_device_count_by_type")
 
@@ -131,11 +133,11 @@ def getDeviceCount(device_type):
 if getDeviceCount("cpu")[0]:
     found_at_least_one_device = True
     lit_config.note("Found available CPU device")
-    cpu_run_substitute = "env SYCL_DEVICE_TYPE=CPU SYCL_BE={SYCL_BE} ".format(SYCL_BE=backend)
+    cpu_run_substitute = "env SYCL_DEVICE_FILTER={SYCL_PLUGIN}:cpu ".format(SYCL_PLUGIN=backend)
     cpu_check_substitute = "| FileCheck %s"
     config.available_features.add('cpu')
     if platform.system() == "Linux":
-        cpu_run_on_linux_substitute = "env SYCL_DEVICE_TYPE=CPU SYCL_BE={SYCL_BE} ".format(SYCL_BE=backend)
+        cpu_run_on_linux_substitute = "env SYCL_DEVICE_FILTER={SYCL_PLUGIN}:cpu ".format(SYCL_PLUGIN=backend)
         cpu_check_on_linux_substitute = "| FileCheck %s"
 else:
     lit_config.warning("CPU device not found")
@@ -157,7 +159,7 @@ def getDeviceCount(device_type):
 if gpu_count > 0:
     found_at_least_one_device = True
     lit_config.note("Found available GPU device")
-    gpu_run_substitute = " env SYCL_DEVICE_TYPE=GPU SYCL_BE={SYCL_BE} ".format(SYCL_BE=backend)
+    gpu_run_substitute = " env SYCL_DEVICE_FILTER={SYCL_PLUGIN}:gpu ".format(SYCL_PLUGIN=backend)
     gpu_check_substitute = "| FileCheck %s"
     config.available_features.add('gpu')
     if cuda:
@@ -166,10 +168,10 @@ def getDeviceCount(device_type):
        config.available_features.add('level_zero')
 
     if platform.system() == "Linux":
-        gpu_run_on_linux_substitute = "env SYCL_DEVICE_TYPE=GPU SYCL_BE={SYCL_BE} ".format(SYCL_BE=backend)
+        gpu_run_on_linux_substitute = "env SYCL_DEVICE_FILTER={SYCL_PLUGIN}:gpu ".format(SYCL_PLUGIN=backend)
         gpu_check_on_linux_substitute = "| FileCheck %s"
     # ESIMD-specific setup. Requires OpenCL for now.
-    esimd_run_substitute = " env SYCL_BE=PI_OPENCL SYCL_DEVICE_TYPE=GPU SYCL_PROGRAM_COMPILE_OPTIONS=-vc-codegen"
+    esimd_run_substitute = " env SYCL_DEVICE_FILTER=opencl:gpu SYCL_PROGRAM_COMPILE_OPTIONS=-vc-codegen"
     config.substitutions.append( ('%ESIMD_RUN_PLACEHOLDER',  esimd_run_substitute) )
     config.substitutions.append( ('%clangxx-esimd',  "clang++ -fsycl-explicit-simd" ) )
 else:
@@ -185,7 +187,7 @@ def getDeviceCount(device_type):
 if getDeviceCount("accelerator")[0]:
     found_at_least_one_device = True
     lit_config.note("Found available accelerator device")
-    acc_run_substitute = " env SYCL_DEVICE_TYPE=ACC "
+    acc_run_substitute = " env SYCL_DEVICE_FILTER={SYCL_PLUGIN}:acc ".format(SYCL_PLUGIN=backend)
     acc_check_substitute = "| FileCheck %s"
     config.available_features.add('accelerator')
 else:

sycl/test/multi_ptr/multi_ptr.cpp

@@ -1,7 +1,7 @@
 // RUN: %clangxx -fsycl -fsycl-targets=%sycl_triple -fsycl-dead-args-optimization %s -o %t.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t.out
+// RUN: %RUN_ON_HOST %t.out
 // RUN: %clangxx -DRESTRICT_WRITE_ACCESS_TO_CONSTANT_PTR -fsycl -fsycl-targets=%sycl_triple -fsycl-dead-args-optimization %s -o %t1.out
-// RUN: env SYCL_DEVICE_TYPE=HOST %t1.out
+// RUN: %RUN_ON_HOST %t1.out
 
 //==--------------- multi_ptr.cpp - SYCL multi_ptr test --------------------==//
 //