Migrate OpenCLVectorTypeHint to ModuleMetaData FuncMD

findeevy · igcbot · commit d909152b820f · 2026-06-05T18:32:16.000+02:00
Move the per-function OpenCL vec_type_hint attribute from the legacy
LLVM-MDNode-based MetaDataApi framework to the plain-memory
ModuleMetaData::FuncMD structure, stored as its ZEBinary string form.

The LLVM-type to string reduction now runs at SPIR-V metadata
translation time and the result is stored as a POD string, so code
generation reads the string directly without an MDNode round-trip. The
underlying VectorTypeHintMetaData class is retained for the SPIR-V input
metadata layer.
diff --git a/IGC/Compiler/CISACodeGen/OpenCLKernelCodeGen.cpp b/IGC/Compiler/CISACodeGen/OpenCLKernelCodeGen.cpp
@@ -533,63 +533,6 @@ uint32_t COpenCLKernel::getMaxPressureForSIMD(llvm::Function &F, unsigned SimdLa
   return maxPressure;
 }
 
-std::string COpenCLKernel::getVecTypeHintTypeString(const VectorTypeHintMetaDataHandle &vecTypeHintInfo) const {
-  std::string vecTypeString;
-
-  // Get the information about the type
-  Type *baseType = vecTypeHintInfo->getVecType()->getType();
-  unsigned int numElements = 1;
-  if (baseType->isVectorTy()) {
-    numElements = (unsigned)cast<IGCLLVM::FixedVectorType>(baseType)->getNumElements();
-    baseType = cast<VectorType>(baseType)->getElementType();
-  }
-
-  // ExecutionModel doesn't differentiate base type in term of signed/unsigned.
-  if (baseType->isIntegerTy()) {
-    vecTypeString += "u";
-  }
-
-  switch (baseType->getTypeID()) {
-  case Type::IntegerTyID:
-    switch (baseType->getIntegerBitWidth()) {
-    case 8:
-      vecTypeString += "char";
-      break;
-    case 16:
-      vecTypeString += "short";
-      break;
-    case 32:
-      vecTypeString += "int";
-      break;
-    case 64:
-      vecTypeString += "long";
-      break;
-    default:
-      IGC_ASSERT_MESSAGE(0, "Unexpected data type in vec_type_hint");
-      break;
-    }
-    break;
-  case Type::DoubleTyID:
-    vecTypeString += "double";
-    break;
-  case Type::FloatTyID:
-    vecTypeString += "float";
-    break;
-  case Type::HalfTyID:
-    vecTypeString += "half";
-    break;
-  default:
-    IGC_ASSERT_MESSAGE(0, "Unexpected data type in vec_type_hint");
-    break;
-  }
-
-  if (numElements != 1) {
-    vecTypeString += utostr(numElements);
-  }
-
-  return vecTypeString;
-}
-
 bool COpenCLKernel::CreateZEPayloadArguments(IGC::KernelArg *kernelArg, uint payloadPosition,
                                              PtrArgsAttrMapType &ptrArgsAttrMap) {
 #ifndef DX_ONLY_IGC
@@ -1832,9 +1775,9 @@ void COpenCLKernel::FillZEUserAttributes(IGC::IGCMD::FunctionInfoMetaDataHandle
   }
 
   // vec_type_hint
-  VectorTypeHintMetaDataHandle vecTypeHintInfo = funcInfoMD->getOpenCLVectorTypeHint();
-  if (vecTypeHintInfo->hasValue()) {
-    m_kernelInfo.m_zeUserAttributes.vec_type_hint = getVecTypeHintTypeString(vecTypeHintInfo);
+  auto itVecTypeHint = m_Context->getModuleMetaData()->FuncMD.find(entry);
+  if (itVecTypeHint != m_Context->getModuleMetaData()->FuncMD.end() && !itVecTypeHint->second.vecTypeHint.empty()) {
+    m_kernelInfo.m_zeUserAttributes.vec_type_hint = itVecTypeHint->second.vecTypeHint;
   }
 
   // work_group_size_hint
diff --git a/IGC/Compiler/CISACodeGen/OpenCLKernelCodeGen.hpp b/IGC/Compiler/CISACodeGen/OpenCLKernelCodeGen.hpp
@@ -184,9 +184,6 @@ class COpenCLKernel : public CComputeShaderBase {
   // Creates annotations for inline sampler_t objects
   void CreateZEInlineSamplerAnnotations();
 
-  // A helper function to get vector type hint string for filling user attributes
-  std::string getVecTypeHintTypeString(const IGC::IGCMD::VectorTypeHintMetaDataHandle &vecTypeHintInfo) const;
-
   // Load from MD and return the resource information for argument number argNo
   SOpenCLKernelInfo::SResourceInfo getResourceInfo(int argNo);
 
diff --git a/IGC/Compiler/MetaDataApi/MetaDataApi.cpp b/IGC/Compiler/MetaDataApi/MetaDataApi.cpp
@@ -218,36 +218,30 @@ FunctionInfoMetaData::FunctionInfoMetaData(const llvm::MDNode *pNode, bool hasId
     : _Mybase(pNode, hasId), m_Type(getNamedNode(pNode, "function_type")),
       m_ArgInfoList(getNamedNode(pNode, "arg_desc"), true),
       m_ImplicitArgInfoList(getNamedNode(pNode, "implicit_arg_desc"), true),
-      m_SubGroupSize(new SubGroupSizeMetaData(getNamedNode(pNode, "sub_group_size"), true)),
-      m_OpenCLVectorTypeHint(new VectorTypeHintMetaData(getNamedNode(pNode, "opencl_vec_type_hint"), true)),
-      m_pNode(pNode) {}
+      m_SubGroupSize(new SubGroupSizeMetaData(getNamedNode(pNode, "sub_group_size"), true)), m_pNode(pNode) {}
 
 FunctionInfoMetaData::FunctionInfoMetaData()
     : m_Type("function_type"), m_ArgInfoList("arg_desc"), m_ImplicitArgInfoList("implicit_arg_desc"),
-      m_SubGroupSize(new SubGroupSizeMetaDataHandle::ObjectType("sub_group_size")),
-      m_OpenCLVectorTypeHint(new VectorTypeHintMetaDataHandle::ObjectType("opencl_vec_type_hint")), m_pNode(nullptr) {}
+      m_SubGroupSize(new SubGroupSizeMetaDataHandle::ObjectType("sub_group_size")), m_pNode(nullptr) {}
 
 FunctionInfoMetaData::FunctionInfoMetaData(const char *name)
     : _Mybase(name), m_Type("function_type"), m_ArgInfoList("arg_desc"), m_ImplicitArgInfoList("implicit_arg_desc"),
-      m_SubGroupSize(new SubGroupSizeMetaDataHandle::ObjectType("sub_group_size")),
-      m_OpenCLVectorTypeHint(new VectorTypeHintMetaDataHandle::ObjectType("opencl_vec_type_hint")), m_pNode(nullptr) {}
+      m_SubGroupSize(new SubGroupSizeMetaDataHandle::ObjectType("sub_group_size")), m_pNode(nullptr) {}
 
 bool FunctionInfoMetaData::hasValue() const {
   return m_Type.hasValue() || m_ArgInfoList.hasValue() || m_ImplicitArgInfoList.hasValue() ||
-         m_SubGroupSize->hasValue() || m_OpenCLVectorTypeHint->hasValue() || nullptr != m_pNode || dirty();
+         m_SubGroupSize->hasValue() || nullptr != m_pNode || dirty();
 }
 
 bool FunctionInfoMetaData::dirty() const {
-  return m_Type.dirty() || m_ArgInfoList.dirty() || m_ImplicitArgInfoList.dirty() || m_SubGroupSize.dirty() ||
-         m_OpenCLVectorTypeHint.dirty();
+  return m_Type.dirty() || m_ArgInfoList.dirty() || m_ImplicitArgInfoList.dirty() || m_SubGroupSize.dirty();
 }
 
 void FunctionInfoMetaData::discardChanges() {
   m_Type.discardChanges();
   m_ArgInfoList.discardChanges();
   m_ImplicitArgInfoList.discardChanges();
   m_SubGroupSize.discardChanges();
-  m_OpenCLVectorTypeHint.discardChanges();
 }
 
 llvm::Metadata *FunctionInfoMetaData::generateNode(llvm::LLVMContext &context) const {
@@ -268,9 +262,6 @@ llvm::Metadata *FunctionInfoMetaData::generateNode(llvm::LLVMContext &context) c
   if (m_SubGroupSize->hasValue()) {
     args.push_back(m_SubGroupSize.generateNode(context));
   }
-  if (m_OpenCLVectorTypeHint->hasValue()) {
-    args.push_back(m_OpenCLVectorTypeHint.generateNode(context));
-  }
   return llvm::MDNode::get(context, args);
 }
 
@@ -286,6 +277,5 @@ void FunctionInfoMetaData::save(llvm::LLVMContext &context, llvm::MDNode *pNode)
   m_ArgInfoList.save(context, getNamedNode(pNode, "arg_desc"));
   m_ImplicitArgInfoList.save(context, getNamedNode(pNode, "implicit_arg_desc"));
   m_SubGroupSize.save(context, getNamedNode(pNode, "sub_group_size"));
-  m_OpenCLVectorTypeHint.save(context, getNamedNode(pNode, "opencl_vec_type_hint"));
 }
 } // namespace IGC::IGCMD
diff --git a/IGC/Compiler/MetaDataApi/MetaDataApi.h b/IGC/Compiler/MetaDataApi/MetaDataApi.h
@@ -20,6 +20,9 @@ using ArgInfoMetaDataHandle = MetaObjectHandle<ArgInfoMetaData>;
 class SubGroupSizeMetaData;
 using SubGroupSizeMetaDataHandle = MetaObjectHandle<SubGroupSizeMetaData>;
 
+// NOTE: VectorTypeHintMetaData is retained solely for the SPIR-V input metadata
+// layer (SpirMetaDataApi.h aliases it as SPIRMD::VectorTypeHintMetaData). The IGC
+// output side now carries the OpenCL vec_type_hint as ModuleMetaData::FuncMD[F].vecTypeHint.
 class VectorTypeHintMetaData;
 using VectorTypeHintMetaDataHandle = MetaObjectHandle<VectorTypeHintMetaData>;
 
@@ -184,6 +187,8 @@ class SubGroupSizeMetaData : public IMetaDataObject {
   SIMDSizeType m_SIMDSize;
 };
 
+// Retained for the SPIR-V input metadata layer only (see SpirMetaDataApi.h).
+// The IGC output side reads/writes ModuleMetaData::FuncMD[F].vecTypeHint instead.
 class VectorTypeHintMetaData : public IMetaDataObject {
 public:
   using _Mybase = IMetaDataObject;
@@ -310,9 +315,6 @@ class FunctionInfoMetaData : public IMetaDataObject {
   // SubGroupSize
   SubGroupSizeMetaDataHandle getSubGroupSize() { return m_SubGroupSize; }
 
-  // OpenCLVectorTypeHint
-  VectorTypeHintMetaDataHandle getOpenCLVectorTypeHint() { return m_OpenCLVectorTypeHint; }
-
 private:
   // parent node
   const llvm::MDNode *m_pNode;
@@ -322,7 +324,6 @@ class FunctionInfoMetaData : public IMetaDataObject {
   ArgInfoListList m_ArgInfoList;
   ImplicitArgInfoListList m_ImplicitArgInfoList;
   SubGroupSizeMetaDataHandle m_SubGroupSize;
-  VectorTypeHintMetaDataHandle m_OpenCLVectorTypeHint;
 };
 
 class MetaDataUtils {
diff --git a/IGC/Compiler/SPIRMetaDataTranslation.cpp b/IGC/Compiler/SPIRMetaDataTranslation.cpp
@@ -10,9 +10,15 @@ SPDX-License-Identifier: MIT
 #include "Compiler/MetaDataApi/SpirMetaDataApi.h"
 #include "Compiler/IGCPassSupport.h"
 #include "Compiler/CodeGenPublic.h"
+#include "Probe/Assertion.h"
+// llvmWrapper/IR/DerivedTypes.h manages its own LLVMWarnings push/pop, so it
+// must be included outside the warnings block below (a nested push with no
+// matching pop trips the guard in LLVMWarningsPush.hpp).
+#include "llvmWrapper/IR/DerivedTypes.h"
 
 #include "common/LLVMWarningsPush.hpp"
 #include "llvm/ADT/StringSwitch.h"
+#include "llvm/ADT/StringExtras.h"
 #include "common/LLVMWarningsPop.hpp"
 
 using namespace llvm;
@@ -45,6 +51,66 @@ bool IGC::isLegalOCLVersion(int major, int minor) {
   return false;
 }
 
+// Reduce an OpenCL vec_type_hint LLVM type to its ZEBinary string form (e.g. "uchar4").
+// Relocated here from COpenCLKernel::getVecTypeHintTypeString as part of migrating the
+// opencl_vec_type_hint metadata from MetaDataApi to ModuleMetaData::FuncMD[F].vecTypeHint:
+// the string is now computed at SPIR-translate time (where the LLVM type is available)
+// and stored as a POD string, so codegen no longer needs the LLVM type.
+static std::string getVecTypeHintTypeString(Type *baseType) {
+  std::string vecTypeString;
+
+  unsigned int numElements = 1;
+  if (baseType->isVectorTy()) {
+    numElements = (unsigned)cast<IGCLLVM::FixedVectorType>(baseType)->getNumElements();
+    baseType = cast<VectorType>(baseType)->getElementType();
+  }
+
+  // ExecutionModel doesn't differentiate base type in term of signed/unsigned.
+  if (baseType->isIntegerTy()) {
+    vecTypeString += "u";
+  }
+
+  switch (baseType->getTypeID()) {
+  case Type::IntegerTyID:
+    switch (baseType->getIntegerBitWidth()) {
+    case 8:
+      vecTypeString += "char";
+      break;
+    case 16:
+      vecTypeString += "short";
+      break;
+    case 32:
+      vecTypeString += "int";
+      break;
+    case 64:
+      vecTypeString += "long";
+      break;
+    default:
+      IGC_ASSERT_MESSAGE(0, "Unexpected data type in vec_type_hint");
+      break;
+    }
+    break;
+  case Type::DoubleTyID:
+    vecTypeString += "double";
+    break;
+  case Type::FloatTyID:
+    vecTypeString += "float";
+    break;
+  case Type::HalfTyID:
+    vecTypeString += "half";
+    break;
+  default:
+    IGC_ASSERT_MESSAGE(0, "Unexpected data type in vec_type_hint");
+    break;
+  }
+
+  if (numElements != 1) {
+    vecTypeString += utostr(numElements);
+  }
+
+  return vecTypeString;
+}
+
 // Khronos SPIRV-LLVM Translator attaches kernel metadata directly to LLVM function, example:
 // define spir_kernel void @bar() !reqd_work_group_size !0
 // ...
@@ -194,9 +260,8 @@ bool SPIRMetaDataTranslation::runOnModule(Module &M) {
     // Handling OpenCL Vector Type Hint
     SPIRMD::VectorTypeHintMetaDataHandle vectorTypeHint = spirKernel->getVectorTypeHint();
     if (vectorTypeHint->hasValue()) {
-      IGCMD::VectorTypeHintMetaDataHandle vthHandle = fHandle->getOpenCLVectorTypeHint();
-      vthHandle->setVecType(vectorTypeHint->getVecType());
-      vthHandle->setSign(vectorTypeHint->getSign());
+      // Sign is not used downstream (vec_type_hint is type-only), so it is not carried over.
+      funcMD.vecTypeHint = getVecTypeHintTypeString(vectorTypeHint->getVecType()->getType());
     }
 
     // Handling OpenCL Kernel Args Address Spaces
diff --git a/IGC/Compiler/tests/MDFrameWork/OpenCLVectorTypeHint/opencl-vector-type-hint.ll b/IGC/Compiler/tests/MDFrameWork/OpenCLVectorTypeHint/opencl-vector-type-hint.ll
@@ -0,0 +1,38 @@
+;=========================== begin_copyright_notice ============================
+;
+; Copyright (C) 2026 Intel Corporation
+;
+; SPDX-License-Identifier: MIT
+;
+;============================ end_copyright_notice =============================
+;
+; REQUIRES: llvm-14-plus
+; RUN: igc_opt --opaque-pointers -igc-serialize-metadata -S < %s | FileCheck %s
+; ------------------------------------------------
+; Verifies that ModuleMetaData::FuncMD[F].vecTypeHint (the OpenCL vec_type_hint
+; kernel attribute, stored as its ZEBinary string form) round-trips through the
+; autogen MDNode serialization. The input embeds the field via the standard
+; !IGCMetadata MD; igc-serialize-metadata re-emits it.
+; ------------------------------------------------
+
+define spir_kernel void @bar(i32 %a) {
+entry:
+  ret void
+}
+
+; CHECK-DAG: {!"vecTypeHint", !"uchar4"}
+
+!IGCMetadata = !{!2}
+
+!2 = !{!"ModuleMD", !3}
+!3 = !{!"FuncMD", !4, !5}
+!4 = !{!"FuncMDMap[0]", ptr @bar}
+!5 = !{!"FuncMDValue[0]", !6, !7, !11, !12, !13}
+!6 = !{!"localOffsets"}
+!7 = !{!"workGroupWalkOrder", !8, !9, !10}
+!8 = !{!"dim0", i32 0}
+!9 = !{!"dim1", i32 1}
+!10 = !{!"dim2", i32 2}
+!11 = !{!"vecTypeHint", !"uchar4"}
+!12 = !{!"funcArgs"}
+!13 = !{!"functionType", !"KernelFunction"}
diff --git a/IGC/Compiler/tests/SPIRMetaDataTranslation/basic.ll b/IGC/Compiler/tests/SPIRMetaDataTranslation/basic.ll
@@ -32,6 +32,7 @@ declare spir_kernel void @test_spir(i64 addrspace(1)*)
 ; CHECK-DAG: [[D2]] = !{!"dim2", i32 16}
 ; CHECK-DAG: {!"threadGroupSizeHint", {{![0-9]+}}, {{![0-9]+}}, [[DH2:![0-9]+]]}
 ; CHECK-DAG: [[DH2]] = !{!"dim2", i32 4}
+; CHECK-DAG: {!"vecTypeHint", !"float4"}
 ; CHECK-DAG: {!"function_type", i32 0}
 ; CHECK-DAG: {!"sub_group_size", i32 16}
 ; CHECK-DAG: {!"m_OpenCLArgAddressSpaces", [[AS_VEC:![0-9]*]]}
diff --git a/IGC/Compiler/tests/SPIRMetaDataTranslation/vec-type-hint.ll b/IGC/Compiler/tests/SPIRMetaDataTranslation/vec-type-hint.ll
@@ -0,0 +1,43 @@
+;=========================== begin_copyright_notice ============================
+;
+; Copyright (C) 2026 Intel Corporation
+;
+; SPDX-License-Identifier: MIT
+;
+;============================ end_copyright_notice =============================
+;
+; UNSUPPORTED: llvm-17-plus
+; RUN: igc_opt --typed-pointers -igc-spir-metadata-translation -igc-serialize-metadata -S < %s | FileCheck %s
+; ------------------------------------------------
+; SPIRMetaDataTranslation
+; ------------------------------------------------
+
+; Verifies the OpenCL vec_type_hint reduction: SPIRMetaDataTranslation turns the
+; SPIR-V !vec_type_hint LLVM type into its ZEBinary string form and stores it in
+; ModuleMetaData::FuncMD[F].vecTypeHint (serialized as {!"vecTypeHint", !"<str>"}).
+; Each kernel exercises a distinct branch of the type->string reduction:
+;   <4 x i8>  -> "uchar4"  (integer 'u' prefix, 8-bit, vector suffix)
+;   <2 x i32> -> "uint2"   (integer 'u' prefix, 32-bit, vector suffix)
+;   double    -> "double"  (non-integer scalar, no prefix, no suffix)
+;   <3 x half>-> "half3"   (non-integer, 16-bit float, vector suffix)
+
+declare spir_kernel void @k_uchar4()
+declare spir_kernel void @k_uint2()
+declare spir_kernel void @k_double()
+declare spir_kernel void @k_half3()
+
+; CHECK-DAG: {!"vecTypeHint", !"uchar4"}
+; CHECK-DAG: {!"vecTypeHint", !"uint2"}
+; CHECK-DAG: {!"vecTypeHint", !"double"}
+; CHECK-DAG: {!"vecTypeHint", !"half3"}
+
+!opencl.kernels = !{!0, !2, !4, !6}
+
+!0 = !{void ()* @k_uchar4, !1}
+!1 = !{!"vec_type_hint", <4 x i8> undef, i32 0}
+!2 = !{void ()* @k_uint2, !3}
+!3 = !{!"vec_type_hint", <2 x i32> undef, i32 0}
+!4 = !{void ()* @k_double, !5}
+!5 = !{!"vec_type_hint", double undef, i32 0}
+!6 = !{void ()* @k_half3, !7}
+!7 = !{!"vec_type_hint", <3 x half> undef, i32 0}
diff --git a/IGC/common/MDFrameWork.h b/IGC/common/MDFrameWork.h
@@ -360,6 +360,7 @@ enum class ShaderTypeMD
         WorkGroupWalkOrderMD workGroupWalkOrder{};
         ThreadGroupSizeMD threadGroupSize{};
         ThreadGroupSizeMD threadGroupSizeHint{};
+        std::string vecTypeHint = ""; // "" = not specified; OpenCL vec_type_hint as ZEBinary string (e.g. "uchar4")
         std::vector<FuncArgMD> funcArgs{};
         FunctionTypeMD functionType = KernelFunction;
         RayTraceShaderInfo rtInfo{};
