Merge pull request intel#854 from myler/backward_compatibility_shliclel751

CMPLRTST-15373: support dpcpp backward compatibility testing on Windows.

Author: myler

SYCL/README.md

@@ -163,6 +163,9 @@ configure specific single test execution in the command line:
  * **sycl_be** - SYCL backend to be used (opencl, ext_oneapi_level_zero,
    ext_oneapi_cuda, ext_oneapi_hip, ext_oneapi_intel_emulator);
  * **dump_ir** - if IR dumping is supported for compiler (True, False);
+ * **compatibility_testing** - forces LIT infra to skip the tests compilation
+   to support compatibility testing (a SYCL application is built with one
+   version of SYCL compiler and then run with different SYCL RT version);
  * **gpu_aot_target_opts** - defines additional options which are passed to AOT
    compilation command line for GPU device. It can be also set by CMake variable
    GPU_AOT_TARGET_OPTS. If not specified "-device *" value is used.

SYCL/lit.cfg.py

@@ -244,8 +244,12 @@
                     '\nUsing fake sycl/sycl.hpp (which just points to CL/sycl.hpp)')
     extra_sycl_include = " " + ("/I" if cl_options else "-I") + config.extra_include
 
-config.substitutions.append( ('%clangxx', ' '+ config.dpcpp_compiler + ' ' + config.cxx_flags + ' ' + arch_flag + extra_sycl_include) )
-config.substitutions.append( ('%clang', ' ' + config.dpcpp_compiler + ' ' + config.c_flags + extra_sycl_include) )
+if lit_config.params.get('compatibility_testing', False):
+    config.substitutions.append( ('%clangxx', ' true ') )
+    config.substitutions.append( ('%clang', ' true ') )
+else:
+    config.substitutions.append( ('%clangxx', ' '+ config.dpcpp_compiler + ' ' + config.cxx_flags + ' ' + arch_flag + extra_sycl_include) )
+    config.substitutions.append( ('%clang', ' ' + config.dpcpp_compiler + ' ' + config.c_flags + extra_sycl_include) )
 
 config.substitutions.append( ('%threads_lib', config.sycl_threads_lib) )
 

llvm_test_suite_sycl.pl

@@ -7,6 +7,7 @@
 my $run_all_lf = "$optset_work_dir/run_all.lf";
 
 my $is_dynamic_suite = 0;
+my $prebuilt_buildstamp = "";
 
 # @test_to_run_list stores only the test(s) that will be run
 # For example, for "tc -t llvm_test_suite_sycl/aot_cpu,aot_gpu" it will store 2 tests - aot_cpu and aot_gpu
@@ -92,9 +93,48 @@ sub is_suite {
     return is_same(\@current_test_list, \@whole_suite_test);
 }
 
+sub compatibility_win {
+  # The backward compatibility testing requires applications that were built by old released compiler
+  # can be run on new runtime, it is difficult to set the correct environment by ics infra because
+  # both compiler executables *.exe and compiler libraries *.dll are in the %PATH% environment.
+  # So, we put pre-built tests on rdrive and use the backward compatibility testing on Windows
+  my $compiler_path = "";
+  if (not defined $ENV{BASECOMPILER}) {
+    $failure_message = "fail to get path of base compiler, requiers option: \"base=1\"";
+    return $COMPFAIL;
+  } else {
+    $compiler_path = $ENV{BASECOMPILER};
+  }
+
+  if ($compiler_path =~ /deploy_(xmain-rel)\/xmainefi2[a-z]{1,}\/([0-9]{8})_([0-9]{6})/) {
+    $prebuilt_buildstamp = "$2\_$3";
+  } else {
+    $failure_message = "fail to get buildstamp of base compiler";
+    return $COMPFAIL;
+  }
+
+  if (not ($current_optset eq "opt_use_cpu" or $current_optset eq "opt_use_gpu")) {
+    $failure_message = "backward compatibility testing only supports 1) opt_use_cpu and 2) opt_use_gpu";
+    return $COMPFAIL;
+  }
+
+  # Always use mainline testbase for both xmain and xmain-rel.
+  my $prebuilt = "$ENV{ICS_TESTDATA}/mainline/CT-SpecialTests/llvm_test_suite/$prebuilt_buildstamp/win/$current_optset/prebuilt.tar.gz";
+  execute("tar -xzf $prebuilt");
+  if ($command_status != 0) {
+    $failure_message = "fail to extract $prebuilt";
+    return $COMPFAIL;
+  }
+
+  # Get test list
+  @test_to_run_list = get_dynamic_test_list();
+  return $PASS;
+}
+
 sub init_test
 {
     if ($current_suite =~ /compatibility_llvm_test_suite_sycl/) {
+      return compatibility_win() if (is_windows());
       my @folder_list = ("SYCL", $config_folder);
       my $folder_not_exist = 0;
       my $sparse_file_in_git = ".git/info/sparse-checkout";
@@ -556,9 +596,14 @@ sub do_run
         $gpu_opts .= "-Dgpu-intel-dg1=1";
       }
 
+      my $backward_compatibility_opts = "";
+      if (is_windows()) {
+        $backward_compatibility_opts = "-Dcompatibility_testing=1";
+      }
+
       set_tool_path();
       if ($is_dynamic_suite == 1 or is_suite()) {
-        execute("$python $lit -a $gpu_opts $matrix $zedebug $jobset . $timeset > $run_all_lf 2>&1");
+        execute("$python $lit -a $backward_compatibility_opts $gpu_opts $matrix $zedebug $jobset . $timeset > $run_all_lf 2>&1");
       } else {
         execute("$python $lit -a $gpu_opts $matrix $zedebug $path $timeset");
       }