[Backport to 15] Deprecate SPV_INTEL_hw_thread_queries extension from forward llvm-spirv (#3130)

Apparently it was never used. Since it was in preview mode - we can remove it.

Signed-off-by: Sidorov, Dmitry <[email protected]>

Author: MrSidims

README.md

@@ -255,3 +255,19 @@ LLVM/Clang release and there are no objections from the maintainer(s). There
 is no guarantee that older release branches are proactively kept up to date
 with main, but you can request specific commits on older release branches by
 creating a pull request or raising an issue on GitHub.
+
+## Deprecation of "preview extensions"
+
+In a case if a "preview extension" has to be deprecated, as the first step one
+should disable support for forward translation of the extension in the main branch
+(this will prevent new SPIR-V modules from being generated using the extension).
+Meanwhile support reverse translation for the extension should be continued
+(this retains compatibility with existing SPIR-V modules).
+  * Addition of deprecation warning for the extension is not required, yet recommended for extensions adding
+    instructions representable in LLVM IR only via SPIR-V friendly LLVM IR.
+  * We encourage backporting the changes to other branches to speed up removal, but this is not required.
+
+After at least one release cycle one may remove support for reverse translation in the main branch as well,
+at which point support for the "preview extension" is considered removed.
+
+These are guidelines, not requirements, and we will consider exceptions on a case-by-case basis.

lib/SPIRV/SPIRVWriter.cpp

@@ -1925,14 +1925,12 @@ LLVMToSPIRVBase::transValueWithoutDecoration(Value *V, SPIRVBasicBlock *BB,
     if (static_cast<uint32_t>(Builtin) >= internal::BuiltInSubDeviceIDINTEL &&
         static_cast<uint32_t>(Builtin) <=
             internal::BuiltInGlobalHWThreadIDINTEL) {
-      if (!BM->isAllowedToUseExtension(
-              ExtensionID::SPV_INTEL_hw_thread_queries)) {
-        std::string ErrorStr = "Intel HW thread queries must be enabled by "
-                               "SPV_INTEL_hw_thread_queries extension.\n"
-                               "LLVM value that is being translated:\n";
-        getErrorLog().checkError(false, SPIRVEC_InvalidModule, V, ErrorStr);
-      }
-      BM->addExtension(ExtensionID::SPV_INTEL_hw_thread_queries);
+      const std::string ErrorStr =
+          "SPV_INTEL_hw_thread_queries\n"
+          "Please report to "
+          "https://github.com/intel/llvm in case if you see "
+          "this error.\nRef LLVM Value:";
+      getErrorLog().checkError(false, SPIRVEC_DeprecatedExtension, V, ErrorStr);
     }
 
     BVar->setBuiltin(Builtin);

lib/SPIRV/libSPIRV/SPIRVErrorEnum.h

@@ -29,3 +29,8 @@ _SPIRV_OP(InvalidVersionNumber,
           "Invalid Version Number.")
 _SPIRV_OP(UnspecifiedMemoryModel, "Unspecified Memory Model.")
 _SPIRV_OP(RepeatedMemoryModel, "Expects a single OpMemoryModel instruction.")
+_SPIRV_OP(DeprecatedExtension,
+          "Feature requires the following deprecated SPIR-V extension:\n")
+
+/* This is the last error code to have a maximum valid value to compare to */
+_SPIRV_OP(InternalMaxErrorCode, "Unknown error code")

test/transcoding/SPV_INTEL_hw_thread_queries/intel_hw_thread_queries_function_call.ll

@@ -1,11 +1,13 @@
-; Negative test for SPV_INTEL_hw_thread_queries feature
-; Check for errors in case if the extension is not enabled, but the appropriate
-; SPV-IR patter is found
+; Deprecation test for SPV_INTEL_hw_thread_queries extension.
+; Check for errors in case if LLVM IR module contains HW thread queries as a for of
+; SPIR-V friendly LLVM IR.
 ; RUN: llvm-as %s -o %t.bc
 ; RUN: not llvm-spirv %t.bc -o %t.spv 2>&1 | FileCheck %s
 
-; CHECK: InvalidModule: Invalid SPIR-V module: Intel HW thread queries must be enabled by SPV_INTEL_hw_thread_queries extension.
-; CHECK: LLVM value that is being translated:
+; CHECK: DeprecatedExtension: Feature requires the following deprecated SPIR-V extension:
+; CHECK: SPV_INTEL_hw_thread_queries
+; CHECK: Please report to https://github.com/intel/llvm in case if you see this error.
+; CHECK: Ref LLVM Value:
 ; CHECK: @__spirv_BuiltInSubDeviceIDINTEL = external addrspace(1) global i32
 
 target datalayout = "e-p:32:32-i64:64-v16:16-v24:32-v32:32-v48:64-v96:128-v192:256-v256:256-v512:512-v1024:1024"