[SYCL][E2E] Add test to check REQUIRES

This test checks the content of every "REQUIRES" to avoid typos and
non-existing requirements.

This PR also updates some tests requirements found during test
development.

Author: KornevNikita

sycl/test-e2e/Basic/fpga_tests/fpga_aocx_win.cpp

@@ -6,8 +6,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-// REQUIRES: opencl-aot, accelerator
-// REQUIRES: system-windows
+// REQUIRES: opencl-aot, accelerator, windows
 
 /// E2E test for AOCX creation/use/run for FPGA
 // Produce an archive with device (AOCX) image. To avoid appending objects to

sycl/test-e2e/Plugin/sycl-ls-gpu-default-level-zero.cpp

@@ -1,4 +1,4 @@
-// REQUIRES: gpu, level-zero
+// REQUIRES: gpu, level_zero
 
 // TODO: Remove unsetting SYCL_DEVICE_FILTER when feature is dropped
 // RUN: env --unset=SYCL_DEVICE_FILTER --unset=ONEAPI_DEVICE_SELECTOR sycl-ls --verbose >%t.default.out

sycl/test-e2e/Regression/msvc_crt.cpp

@@ -2,7 +2,7 @@
 // RUN: %{run} %t1.exe
 // RUN: %{build} /MDd -o %t2.exe
 // RUN: %{run} %t2.exe
-// REQUIRES: system-windows, cl_options
+// REQUIRES: windows, cl_options
 //==-------------- msvc_crt.cpp - SYCL MSVC CRT test -----------------------==//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

sycl/test-e2e/SpecConstants/2020/native_specialization_constant.cpp

@@ -3,7 +3,7 @@
 // (because only SPIR-V supports specialization constants natively)
 
 // FIXME: This set is never satisfied all at once in our infrastructure.
-// REQUIRES: opencl, level-zero, cpu, gpu, opencl-aot, ocloc
+// REQUIRES: opencl, level_zero, cpu, gpu, opencl-aot, ocloc
 
 // RUN: %clangxx -fsycl -DJIT %s -o %t.out
 // RUN: %{run} %t.out

sycl/test/e2e_test_requirements/check-correctness-of-requires.cpp

@@ -0,0 +1,10 @@
+// This test checks that all "REQUIRES" strings contain the right feature names
+// If this test fails:
+// 1. there is some typo/non-existing feature request in the
+//    modified test.
+// 2. ...or, there is some new feature. In this case please update the set of
+//    features in check-correctness-of-requires.py
+//
+// RUN: grep -rI --include=*.cpp "REQUIRES: " %S/../../test-e2e | sed -E 's|.*/test-e2e/||' > %t
+// Using a python script as it's easier to work with sets there
+// RUN: python3 %S/check-correctness-of-requires.py %t %sycl_include

sycl/test/e2e_test_requirements/check-correctness-of-requires.py

@@ -0,0 +1,116 @@
+# See check-correctness-of-requires.cpp
+
+import re
+import sys
+
+
+# To parse .def files to get aspects and architectures
+def parse_defines(path, macro, prefix):
+    features = set()
+    with open(path, "r") as file:
+        for line in file:
+            if line.startswith(macro):
+                feature = line.split("(")[1].split(",")[0].strip()
+                features.add(f"{prefix}-{feature}")
+        return features
+
+
+def parse_requirements(input_data_path, sycl_include_dir_path):
+    available_features = {
+        # host OS:
+        "windows",
+        "linux",
+        # target device:
+        "cpu",
+        "gpu",
+        "accelerator",
+        # target backend:
+        "cuda",
+        "hip",
+        "opencl",
+        "level_zero",
+        "native_cpu",
+        "hip_amd",
+        # tools:
+        "sycl-ls",
+        "cm-compiler",
+        "aot_tool",
+        "ocloc",
+        "opencl-aot",
+        "llvm-spirv",
+        "llvm-link",
+        # dev-kits:
+        "level_zero_dev_kit",
+        "cuda_dev_kit",
+        # manually-set features (deprecated, no new tests should use these features)
+        "gpu-intel-gen11",
+        "gpu-intel-gen12",
+        "gpu-intel-dg1",
+        "gpu-intel-dg2",
+        "gpu-intel-pvc",
+        "gpu-intel-pvc-vg",
+        "gpu-amd-gfx90a",
+        # any-device-is-:
+        "any-device-is-cpu",
+        "any-device-is-gpu",
+        "any-device-is-accelerator",
+        "any-device-is-cuda",
+        "any-device-is-hip",
+        "any-device-is-opencl",
+        "any-device-is-level_zero",
+        # sg-sizes (should we allow any sg-X?)
+        "sg-8",
+        "sg-16",
+        "sg-32",
+        # miscellaneous:
+        "cl_options",
+        "opencl_icd",
+        "dump_ir",
+        "xptifw",
+        "has_ndebug",
+        "zstd",
+        "preview-breaking-changes-supported",
+        "vulkan",
+        # Note: aspects and architectures are gathered below
+    }
+
+    available_features.update(
+        parse_defines(
+            sycl_include_dir_path + "/sycl/info/aspects.def", "__SYCL_ASPECT", "aspect"
+        )
+    )
+    available_features.update(
+        parse_defines(
+            sycl_include_dir_path + "/sycl/info/aspects_deprecated.def",
+            "__SYCL_ASPECT",
+            "aspect",
+        )
+    )
+    available_features.update(
+        parse_defines(
+            sycl_include_dir_path + "/sycl/ext/oneapi/experimental/architectures.def",
+            "__SYCL_ARCHITECTURE",
+            "arch",
+        )
+    )
+
+    exit_code = 0
+    with open(input_data_path, "r") as file:
+        for line in file:
+            # get the content of "REQUIRES: "
+            requirements = re.compile(r"// REQUIRES: (.*)").search(line)
+            # Drop all symbols except feature names
+            requirements = re.split(r"&&|\|\||, |,|\(|\)|\s+", requirements.group(1))
+            # Filter out empty names
+            requirements = [req.strip() for req in requirements if req.strip()]
+
+            for feature in requirements:
+                # some names can start with "!" e.g. "!level_zero", drop "!"
+                feature = feature.lstrip("!")
+                if not feature in available_features:
+                    exit_code = 1
+                    print(line + "contains unsupported feature: " + feature)
+    sys.exit(exit_code)
+
+
+parse_requirements(sys.argv[1], sys.argv[2])

sycl/test/regression/sycl-include-gnu17.cpp

@@ -1,7 +1,7 @@
 // RUN: %clangxx -std=gnu++17 -fsycl -fsycl-targets=%sycl_triple %s -o %t.out
 // RUN: %t.out
 
-// UNSUPPORTED: system-windows
+// UNSUPPORTED: windows
 
 #include <iostream>
 #include <sycl/sycl.hpp>