Adding hitgroups to ModuleMetaData

krystian-andrzejewski · igcbot · commit ffb070ed83f2 · 2025-03-25T21:52:31.000+01:00
This change is to add a hitgroup definition in llvm metadata.
diff --git a/IGC/AdaptorCommon/RayTracing/ConstantsEnums.h b/IGC/AdaptorCommon/RayTracing/ConstantsEnums.h
@@ -0,0 +1,42 @@
+/*========================== begin_copyright_notice ============================
+
+Copyright (C) 2020-2025 Intel Corporation
+
+SPDX-License-Identifier: MIT
+
+============================= end_copyright_notice ===========================*/
+
+#pragma once
+
+#include <stdint.h>
+
+namespace RTStackFormat
+{
+    enum class HIT_GROUP_TYPE
+    {
+        TRIANGLES = 0x0,
+        PROCEDURAL_PRIMITIVE = 0x1,
+    };
+
+    enum struct RayTracingShaderType
+    {
+        ANY_HIT              = 0b0000,
+        CLOSEST_HIT          = 0b0001,
+        MISS                 = 0b0010,
+        INTERSECTION         = 0b0011,
+        RESERVED             = 0b0100
+    };
+
+    enum HIT_KIND
+    {
+        HIT_KIND_TRIANGLE_FRONT_FACE = 254,
+        HIT_KIND_TRIANGLE_BACK_FACE = 255
+    };
+
+    constexpr static uint32_t RAYTRACING_MAX_DECLARABLE_TRACE_RECURSION_DEPTH = 31;
+    constexpr static uint32_t RAYTRACING_MAX_ATTRIBUTE_SIZE_IN_BYTES = 32;
+    constexpr static uint32_t RAYTRACING_SHADER_RECORD_BYTE_ALIGNMENT = 32;
+    constexpr static uint32_t RAYTRACING_SHADER_TABLE_BYTE_ALIGNMENT = 64;
+
+    constexpr static uint32_t SHADER_IDENTIFIER_SIZE_IN_BYTES = 32;
+}
diff --git a/IGC/AdaptorCommon/RayTracing/HitGroups.h b/IGC/AdaptorCommon/RayTracing/HitGroups.h
@@ -0,0 +1,30 @@
+/*========================== begin_copyright_notice ============================
+
+Copyright (C) 2021 Intel Corporation
+
+SPDX-License-Identifier: MIT
+
+============================= end_copyright_notice ===========================*/
+
+#pragma once
+
+#include <string>
+#include <optional>
+
+#include "ConstantsEnums.h"
+
+#include "common/LLVMWarningsPush.hpp"
+#include "common/LLVMWarningsPop.hpp"
+
+namespace IGC {
+
+struct HitGroupInfo
+{
+    std::string HitGroupName;
+    RTStackFormat::HIT_GROUP_TYPE Type;
+    std::string ClosestHit;
+    std::string Intersection;
+    std::string AnyHit;
+};
+
+} // namespace IGC
diff --git a/IGC/AdaptorCommon/RayTracing/RTStackFormat.h b/IGC/AdaptorCommon/RayTracing/RTStackFormat.h
@@ -15,6 +15,7 @@ SPDX-License-Identifier: MIT
 #pragma once
 
 #include "API/RayDispatchGlobalData.h"
+#include "ConstantsEnums.h"
 
 #include <stdint.h>
 #include <stddef.h>
diff --git a/IGC/DriverInterface/CMakeLists.txt b/IGC/DriverInterface/CMakeLists.txt
@@ -112,6 +112,8 @@ set(IGC_BUILD__HDR__DriverInterface
   )
 
   set(IGC_BUILD__HDR__RAYTRACING
+    "${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/ConstantsEnums.h"
+    "${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/HitGroups.h"
     "${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/MemRegionAnalysis.h"
     "${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/RayTracingAddressSpaceAliasAnalysis.h"
     "${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/RayTracingMemoryStyle.h"
diff --git a/IGC/common/MDFrameWork.h b/IGC/common/MDFrameWork.h
@@ -22,6 +22,8 @@ SPDX-License-Identifier: MIT
 #include <llvm/ADT/SetVector.h>
 #include "common/LLVMWarningsPop.hpp"
 
+#include "AdaptorCommon/RayTracing/HitGroups.h" // ^MDFramework^: ../AdaptorCommon/RayTracing
+#include "AdaptorCommon/RayTracing/ConstantsEnums.h" // ^MDFramework^: ../AdaptorCommon/RayTracing
 #include "AdaptorCommon/RayTracing/API/MemoryStyleEnum.h" // ^MDFramework^: ../AdaptorCommon/RayTracing/API
 
 namespace llvm
@@ -815,6 +817,8 @@ enum class ShaderTypeMD
 
         llvm::MapVector<llvm::Value*, llvm::Value*> predicationMap;
         llvm::MapVector<llvm::Value*, llvm::Value*> lifeTimeStartMap;
+
+        std::vector<HitGroupInfo> HitGroups;
     };
 
     void serialize(const IGC::ModuleMetaData &moduleMD, llvm::Module* module);
diff --git a/IGC/common/autogen.py b/IGC/common/autogen.py
@@ -17,13 +17,16 @@ class DeclHeader:
     line: str
     # declName is just the identifier name
     declName: str
+    # declName is just the identifier name
+    namespace: str
     # fields contains a list of all the names of the fields in the structure
     fields: List[str]
 
-    def __init__(self, line: str, declName: str, fields: List[str]):
-        self.line     = line
-        self.declName = declName
-        self.fields   = fields
+    def __init__(self, line: str, namespace: str, declName: str, fields: List[str]):
+        self.line      = line
+        self.namespace = namespace
+        self.declName  = declName
+        self.fields    = fields
 
 enumNames: List[DeclHeader] = []
 structureNames: List[DeclHeader] = []
@@ -73,45 +76,45 @@ def lines(s: str) -> Generator[str, None, None]:
         yield line
 
 def parseHeader(fileContents: str):
-    insideIGCNameSpace = False
+    namespace = ""
     pcount = 0
     file = lines(fileContents)
     for line in file:
         line = line.split("//")[0]
-        if "namespace IGC" in line:
+        if "namespace" in line:
+            words = line.split()
             while "{" not in line:
                 line = next(file, None)
                 if line is None:
                     sys.exit('missing opening brace!')
-            insideIGCNameSpace = True
+            namespace = words[1] if len(words) > 1 else ""
             pcount += 1
-        if insideIGCNameSpace:
-            blockType = re.search("struct|enum", line)
-            if blockType:
-                words = line.split()
-                idx = 2 if 'class' in words else 1
-                foundDecl = DeclHeader(line, words[idx], [])
-                opcount = pcount
-                namesList = structureNames
-                extractFunc = extractStructField
-                if blockType[0] == 'enum':
-                    namesList = enumNames
-                    extractFunc = extractEnumVal
-                while True:
-                    line = next(file, None)
-                    if line is None:
-                        sys.exit(f"EOF reached with unclosed enum or struct, check formatting")
-                    line = line.split("//")[0]
-                    pcount += line.count("{") - line.count("}")
-                    if pcount <= opcount:
-                        break
-                    extractFunc(re.sub("{|}","", line), foundDecl)
-                assert pcount == opcount, f"Unexpected struct/enum ending, check formatting"
-                namesList.append(foundDecl)
-            elif "}" in line and "};" not in line:
-                insideIGCNameSpace = False
-                pcount -= 1
-    assert pcount == 0, f"EOF reached, with unclosed IGC namespace, check formatting"
+        blockType = re.search("struct|enum", line)
+        if blockType:
+            words = line.split()
+            idx = 2 if blockType[0] == 'enum' and ('class' in words or 'struct' in words) else 1
+            foundDecl = DeclHeader(line, namespace, words[idx], [])
+            opcount = pcount
+            namesList = structureNames
+            extractFunc = extractStructField
+            if blockType[0] == 'enum':
+                namesList = enumNames
+                extractFunc = extractEnumVal
+            while True:
+                line = next(file, None)
+                if line is None:
+                    sys.exit(f"EOF reached with unclosed enum or struct, check formatting")
+                line = line.split("//")[0]
+                pcount += line.count("{") - line.count("}")
+                if pcount <= opcount:
+                    break
+                extractFunc(re.sub("{|}","", line), foundDecl)
+            assert pcount == opcount, f"Unexpected struct/enum ending, check formatting"
+            namesList.append(foundDecl)
+        elif "}" in line and "};" not in line:
+            insideIGCNameSpace = False
+            pcount -= 1
+    assert pcount == 0, f"EOF reached, with unclosed namespace, check formatting"
 
 def stripBlockComments(text: str) -> str:
     return re.sub(r'/\*(.|\s)*?\*/', '', text)
@@ -164,7 +167,7 @@ def printEnumCalls(enumDecl: DeclHeader, outputFile: TextIO):
     outputFile.write(f"    switch({enumDecl.declName}Var)\n")
     outputFile.write("    {\n")
     for item in enumDecl.fields:
-        outputFile.write(f"        case IGC::{enumDecl.declName}::{item}:\n")
+        outputFile.write(f"        case {enumDecl.namespace}::{enumDecl.declName}::{item}:\n")
         outputFile.write("            enumName = ")
         outputFile.write(f'"{item}"')
         outputFile.write(";\n")
@@ -193,41 +196,41 @@ def printEnumReadCalls(enumDecl: DeclHeader, outputFile: TextIO):
         outputFile.write(f'"{item}"')
         outputFile.write(") == 0)\n")
         outputFile.write("    {\n")
-        outputFile.write(f"        {enumDecl.declName}Var = IGC::{enumDecl.declName}::{item};\n")
+        outputFile.write(f"        {enumDecl.declName}Var = {enumDecl.namespace}::{enumDecl.declName}::{item};\n")
         outputFile.write("    }\n")
         first = False
 
     outputFile.write("    else\n")
     outputFile.write("    {\n")
-    outputFile.write(f"        {enumDecl.declName}Var = (IGC::{enumDecl.declName})(0);\n")
+    outputFile.write(f"        {enumDecl.declName}Var = ({enumDecl.namespace}::{enumDecl.declName})(0);\n")
     outputFile.write("    }\n")
 
 
-def emitCodeBlock(names: List[DeclHeader], fmtFn: Callable[[str], str], printFn: Callable[[DeclHeader, TextIO], None], outputFile: TextIO):
+def emitCodeBlock(names: List[DeclHeader], fmtFn: Callable[[str, str], str], printFn: Callable[[DeclHeader, TextIO], None], outputFile: TextIO):
     for item in names:
-        outputFile.write(fmtFn(item.declName))
+        outputFile.write(fmtFn(item.namespace, item.declName))
         outputFile.write("{\n")
         printFn(item, outputFile)
         outputFile.write("}\n\n")
 
 def emitEnumCreateNode(outputFile: TextIO):
-    def fmtFn(item: str):
-        return f"MDNode* CreateNode(IGC::{item} {item}Var, Module* module, StringRef name)\n"
+    def fmtFn(namespace:str, item: str):
+        return f"MDNode* CreateNode({namespace}::{item} {item}Var, Module* module, StringRef name)\n"
     emitCodeBlock(enumNames, fmtFn, printEnumCalls, outputFile)
 
 def emitStructCreateNode(outputFile: TextIO):
-    def fmtFn(item: str):
-        return f"MDNode* CreateNode(const IGC::{item}& {item}Var, Module* module, StringRef name)\n"
+    def fmtFn(namespace:str, item: str):
+        return f"MDNode* CreateNode(const {namespace}::{item}& {item}Var, Module* module, StringRef name)\n"
     emitCodeBlock(structureNames, fmtFn, printStructCalls, outputFile)
 
 def emitEnumReadNode(outputFile: TextIO):
-    def fmtFn(item: str):
-        return f"void readNode(IGC::{item}& {item}Var, MDNode* node)\n"
+    def fmtFn(namespace:str, item: str):
+        return f"void readNode({namespace}::{item}& {item}Var, MDNode* node)\n"
     emitCodeBlock(enumNames, fmtFn, printEnumReadCalls, outputFile)
 
 def emitStructReadNode(outputFile: TextIO):
-    def fmtFn(item: str):
-        return f"void readNode(IGC::{item}& {item}Var, MDNode* node)\n"
+    def fmtFn(namespace:str, item: str):
+        return f"void readNode({namespace}::{item}& {item}Var, MDNode* node)\n"
     emitCodeBlock(structureNames, fmtFn, printStructReadCalls, outputFile)
 
 def genCode(fileName: str):

Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,8 @@ set(IGC_BUILD__HDR__DriverInterface`
`112`	`112`	`)`
`113`	`113`
`114`	`114`	`set(IGC_BUILD__HDR__RAYTRACING`
	`115`	`+ "${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/ConstantsEnums.h"`
	`116`	`+ "${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/HitGroups.h"`
`115`	`117`	`"${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/MemRegionAnalysis.h"`
`116`	`118`	`"${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/RayTracingAddressSpaceAliasAnalysis.h"`
`117`	`119`	`"${CMAKE_CURRENT_SOURCE_DIR}/../AdaptorCommon/RayTracing/RayTracingMemoryStyle.h"`