Platform checker for VC internal intrinsics

VC should check the platform for internal intrinsics and emit an error
during codegen, if the intrinsic is not supported by the platform.
The new checker is implemented on top of the existing subtarget feature
set.

Author: vmustya

IGC/VectorCompiler/include/CMakeLists.txt

@@ -1,6 +1,6 @@
 #=========================== begin_copyright_notice ============================
 #
-# Copyright (C) 2020-2021 Intel Corporation
+# Copyright (C) 2020-2024 Intel Corporation
 #
 # SPDX-License-Identifier: MIT
 #
@@ -17,7 +17,8 @@ target_include_directories(VCHeaders
   INTERFACE
   ${CMAKE_CURRENT_SOURCE_DIR}
   ${CMAKE_CURRENT_BINARY_DIR}
-  )
+  ${CMAKE_CURRENT_BINARY_DIR}/vc/InternalIntrinsics
+)
 
 add_dependencies(VCHeaders
   intrinsics_gen

IGC/VectorCompiler/include/vc/InternalIntrinsics/Intrinsic_definitions.py

@@ -2,7 +2,7 @@
 
 # ========================== begin_copyright_notice ============================
 #
-# Copyright (C) 2022-2023 Intel Corporation
+# Copyright (C) 2022-2024 Intel Corporation
 #
 # SPDX-License-Identifier: MIT
 #
@@ -416,6 +416,72 @@ def createAttributeTable():
             "#endif // GET_INTRINSIC_ATTRIBUTES\n\n")
     f.close()
 
+def createPlatformTable():
+    key = 'target'
+
+    # Collect all the required target features
+    targetFeatures = set()
+    for desc in Intrinsics.values():
+        feat = [x[1:] if x[0] == '!' else x for x in desc.get(key, [])]
+        targetFeatures.update(feat)
+
+    # Create bit mask for each target feature
+    targetFeatureMap = {feature: 1 << i for i, feature in enumerate(sorted(targetFeatures))}
+
+    # Generate the tables
+    tableRequired = []
+    tableForbidden = []
+    for i in range(len(ID_array)):
+        desc = Intrinsics[ID_array[i]]
+        features = desc.get(key, [])
+
+        required = [feature for feature in features if not feature.startswith('!')]
+        tableRequired.append(reduce(lambda acc, feature: acc | targetFeatureMap[feature], required, 0))
+
+        forbidden = [feature[1:] for feature in features if feature.startswith('!')]
+        tableForbidden.append(reduce(lambda acc, feature: acc | targetFeatureMap[feature], forbidden, 0))
+
+    numFeatures = len(targetFeatureMap)
+    assert numFeatures <= 64, "Too many target features"
+
+    storageType = 'uint64_t'
+    if numFeatures <= 8:
+        storageType = 'uint8_t'
+    elif numFeatures <= 16:
+        storageType = 'uint16_t'
+    elif numFeatures <= 32:
+        storageType = 'uint32_t'
+
+    # Write the table to the output file
+    with open(outputFile, 'a') as f:
+        f.write("// Platform table\n"
+                "#ifdef GET_INTRINSIC_TARGET_FEATURE_TABLE\n"
+                f"static const {storageType} RequiredTargetFeatures[] = " "{\n")
+
+        for i, mask in enumerate(tableRequired):
+            f.write("  0x{:x}, // llvm.vc.internal.{}\n".format(mask, ID_array[i].replace("_", ".")))
+
+        f.write("};\n"
+                f"static const {storageType} ForbiddenTargetFeatures[] = " "{\n")
+
+        for i, mask in enumerate(tableForbidden):
+            f.write("  0x{:x}, // llvm.vc.internal.{}\n".format(mask, ID_array[i].replace("_", ".")))
+
+        f.write("};\n"
+                "#endif // GET_INTRINSIC_TARGET_FEATURE_TABLE\n\n")
+
+        f.write("// Checker for platform features\n"
+                "#ifdef GET_INTRINSIC_TARGET_FEATURE_CHECKER\n"
+                "unsigned Index = ID - 1 - vc::InternalIntrinsic::not_internal_intrinsic;\n"
+                "auto MaskRequired = RequiredTargetFeatures[Index];\n"
+                "auto MaskForbidden = ForbiddenTargetFeatures[Index];\n")
+
+        for feature, mask in targetFeatureMap.items():
+            f.write(f"if ((MaskRequired & {mask}) && !{feature}()) return false;\n"
+                    f"if ((MaskForbidden & {mask}) && {feature}()) return false;\n")
+        f.write("#endif // GET_INTRINSIC_TARGET_FEATURE_CHECKER\n\n")
+
+
 def emitSuffix():
     f = open(outputFile,"a")
     f.write("#if defined(_MSC_VER) && defined(setjmp_undefined_for_msvc)\n"
@@ -435,4 +501,5 @@ def emitSuffix():
 createOverloadRetTable()
 createTypeTable()
 createAttributeTable()
+createPlatformTable()
 emitSuffix()

IGC/VectorCompiler/include/vc/InternalIntrinsics/Intrinsics.py

@@ -2685,12 +2685,11 @@ bool GenXKernelBuilder::buildMainInst(Instruction *Inst, BaleInfo BI,
       Function *Callee = CI->getCalledFunction();
       unsigned IntrinID = vc::getAnyIntrinsicID(Callee);
 
-      if (GenXIntrinsic::isGenXIntrinsic(IntrinID) &&
-          !GenXIntrinsic::isSupportedPlatform(Subtarget->getCPU().str(),
-                                              IntrinID)) {
+      if (vc::isAnyNonTrivialIntrinsic(IntrinID) &&
+          !Subtarget->isIntrinsicSupported(IntrinID)) {
         vc::diagnose(getContext(), "GenXCisaBuilder",
-                     "Intrinsic is not supported by <" + Subtarget->getCPU() +
-                         "> platform",
+                     "Intrinsic is not supported by the <" +
+                         Subtarget->getCPU() + "> platform",
                      Inst);
       }
 

IGC/VectorCompiler/lib/GenXCodeGen/GenXCisaBuilder.cpp

@@ -1,6 +1,6 @@
 /*========================== begin_copyright_notice ============================
 
-Copyright (C) 2017-2023 Intel Corporation
+Copyright (C) 2017-2024 Intel Corporation
 
 SPDX-License-Identifier: MIT
 
@@ -11,18 +11,21 @@ SPDX-License-Identifier: MIT
 //
 //===----------------------------------------------------------------------===//
 
-#include "IGC/common/StringMacros.hpp"
-
 #include "GenXSubtarget.h"
-#include "common/StringMacros.hpp"
+
+#include "vc/Utils/GenX/IntrinsicsWrapper.h"
+
 #include "llvm/CodeGen/MachineFunction.h"
 #include "llvm/IR/Attributes.h"
 #include "llvm/IR/Function.h"
 #include "llvm/IR/GlobalValue.h"
 #include "llvm/IR/InstrTypes.h"
 #include "llvm/Target/TargetMachine.h"
 #include "llvm/Target/TargetOptions.h"
+
+#include "IGC/common/StringMacros.hpp"
 #include "Probe/Assertion.h"
+#include "common/StringMacros.hpp"
 
 using namespace llvm;
 
@@ -251,3 +254,23 @@ TARGET_PLATFORM GenXSubtarget::getVisaPlatform() const {
     return TARGET_PLATFORM::GENX_NONE;
   }
 }
+
+bool GenXSubtarget::isIntrinsicSupported(unsigned ID) const {
+  if (vc::InternalIntrinsic::isInternalIntrinsic(ID))
+    return isInternalIntrinsicSupported(ID);
+  if (GenXIntrinsic::isGenXIntrinsic(ID))
+    return GenXIntrinsic::isSupportedPlatform(getCPU().str(), ID);
+  return ID < Intrinsic::num_intrinsics;
+}
+
+bool GenXSubtarget::isInternalIntrinsicSupported(unsigned ID) const {
+  IGC_ASSERT(vc::InternalIntrinsic::isInternalIntrinsic(ID));
+
+#define GET_INTRINSIC_TARGET_FEATURE_TABLE
+#define GET_INTRINSIC_TARGET_FEATURE_CHECKER
+#include "InternalIntrinsicDescription.gen"
+#undef GET_INTRINSIC_TARGET_FEATURE_TABLE
+#undef GET_INTRINSIC_TARGET_FEATURE_CHECKER
+
+  return true;
+}

IGC/VectorCompiler/lib/GenXCodeGen/GenXSubtarget.cpp

@@ -270,6 +270,8 @@ class GenXSubtarget final : public GenXGenSubtargetInfo {
   // \brief Initialize the features for the GenX target.
   void initSubtargetFeatures(StringRef CPU, StringRef FS);
 
+  bool isInternalIntrinsicSupported(unsigned ID) const;
+
 public:
   /// * translateMediaWalker - true if translate media walker APIs
   bool translateMediaWalker() const { return !HasMediaWalker; }
@@ -442,6 +444,8 @@ class GenXSubtarget final : public GenXGenSubtargetInfo {
 
   /// * stackSurface - return a surface that should be used for stack.
   PreDefined_Surface stackSurface() const { return StackSurf; }
+
+  bool isIntrinsicSupported(unsigned ID) const;
 };
 
 } // namespace llvm

IGC/VectorCompiler/lib/GenXCodeGen/GenXSubtarget.h

@@ -20,7 +20,7 @@
 
 ; CHECK-XeHPCVG: GenXCisaBuilder failed for:
 ; CHECK-XeHPCVG-SAME: %acc = call <16 x i32> @llvm.genx.dpas.nosrc0.v16i32.v128i32.v8i32(<128 x i32> %src1, <8 x i32> %src2, i32 17303560)
-; CHECK-XeHPCVG-SAME: Intrinsic is not supported by <XeHPCVG> platform
+; CHECK-XeHPCVG-SAME: Intrinsic is not supported by the <XeHPCVG> platform
 
 ; COM: ;;;;;;;;;; KERNEL ;;;;;;;;;;
 

IGC/VectorCompiler/test/CisaBuilder/dpas/dpas-nosrc0.ll

@@ -20,7 +20,7 @@
 
 ; CHECK-XeHPCVG: error: LLVM ERROR: GenXCisaBuilder failed for:
 ; CHECK-XeHPCVG-SAME: %acc.1 = call <16 x i32> @llvm.genx.dpas.v16i32.v16i32.v128i32.v8i32(<16 x i32> %acc.0, <128 x i32> %src1, <8 x i32> %src2, i32 17303560)
-; CHECK-XeHPCVG-SAME: Intrinsic is not supported by <XeHPCVG> platform
+; CHECK-XeHPCVG-SAME: Intrinsic is not supported by the <XeHPCVG> platform
 
 
 ; COM: ;;;;;;;;;; KERNEL ;;;;;;;;;;

IGC/VectorCompiler/test/CisaBuilder/dpas/dpas.ll

@@ -20,7 +20,7 @@
 
 ; CHECK-XeHPCVG: error: LLVM ERROR: GenXCisaBuilder failed for:
 ; CHECK-XeHPCVG-SAME: %acc.1 = call <16 x i32> @llvm.genx.dpas2.v16i32.v16i32.v128i32.v8i32(<16 x i32> %acc.0, <128 x i32> %src1, <8 x i32> %src2, i32 8, i32 8, i32 8, i32 1, i32 1, i32 1)
-; CHECK-XeHPCVG-SAME: Intrinsic is not supported by <XeHPCVG> platform
+; CHECK-XeHPCVG-SAME: Intrinsic is not supported by the <XeHPCVG> platform
 
 
 ; COM: ;;;;;;;;;; KERNEL ;;;;;;;;;;