From 9f786fdf71e90339e20979ef3ba8f073657f5a98 Mon Sep 17 00:00:00 2001
From: kaizhangNV <149626564+kaizhangNV@users.noreply.github.com>
Date: Fri, 17 May 2024 11:43:08 -0500
Subject: capture/relay: Add capture interface classes (#4177)

* capture/relay: Add capture interface classes

Add `ModuleCapture` class for capturing `IModule`
  - The `IModule` can only be created from
    -- `ISession::loadModule`
    -- `ISession::loadModuleFromIRBlob`
    -- `ISession::loadModuleFromSource`
    -- `ISession::loadModuleFromSourceString`
    so, we create the `ModuleCapture` at those methods in `SessionCapture`
    class. We use a hash map to store a map from `IModule` to `ModuleCapture`
    to avoid creating new `ModuleCapture` when there is already an old one.
  - In `SessionCapture::getLoadedModule`, we will assert on not finding
    a `ModuleCapture` instance.

Add `EntryPointCapture` class for capturing `IEntryPoint`.
  - The `IEntryPoint` can only be created from:
    -- `IModule::findEntryPointByName`
    -- `IModule::findAndCheckEntryPoint`
    so, we create the `EntryPointCapture` at those methods in `ModuleCapture`.
    Similarly, we use a hash map to store a map from `IEntryPoint` to
    `EntryPointCapture`.
  - In `IModule::getDefinedEntryPoint`, we will assert on not finding
    a `EntryPointCapture` instance.

Add `CompositeComponentTypeCapture` class for capturing CompositeComponentType,
but since user is only exposed to `IComponentType`, so `CompositeComponentTypeCapture`
just inherits from `IComponentType`.
  - `CompositeComponentType` can only be created from:
    -- ISession::createCompositeComponentType
    so create it here.

Add `TypeConformanceCapture` class for capturing `ITypeConformance`.
  - The `ITypeConformance` can only be created from:
    -- `ISession::createTypeConformanceComponentType`
    so create it here.

In addition, because `EntryPointCapture` and `ModuleCapture` share a some
base class `IComponentType`, we generate the COM GUID for those two
classes to differentiate them.

* Fix the build issue

* Add nullptr check for output parameter

* define the SLANG_CAPTURE_ASSERT macro used in both debug and release build
---
 build/visual-studio/slang/slang.vcxproj         |  8 ++++++++
 build/visual-studio/slang/slang.vcxproj.filters | 24 ++++++++++++++++++++++++
 2 files changed, 32 insertions(+)

(limited to 'build/visual-studio')

diff --git a/build/visual-studio/slang/slang.vcxproj b/build/visual-studio/slang/slang.vcxproj
index 65bac7516..6730297c5 100644
--- a/build/visual-studio/slang/slang.vcxproj
+++ b/build/visual-studio/slang/slang.vcxproj
@@ -309,9 +309,13 @@ IF EXIST ..\..\..\external\slang-glslang\bin\windows-aarch64\release\slang-glsla
   <ItemGroup>
     <ClInclude Include="..\..\..\slang.h" />
     <ClInclude Include="..\..\..\source\slang-capture-replay\capture_utility.h" />
+    <ClInclude Include="..\..\..\source\slang-capture-replay\slang-composite-component-type.h" />
+    <ClInclude Include="..\..\..\source\slang-capture-replay\slang-entrypoint.h" />
     <ClInclude Include="..\..\..\source\slang-capture-replay\slang-filesystem.h" />
     <ClInclude Include="..\..\..\source\slang-capture-replay\slang-global-session.h" />
+    <ClInclude Include="..\..\..\source\slang-capture-replay\slang-module.h" />
     <ClInclude Include="..\..\..\source\slang-capture-replay\slang-session.h" />
+    <ClInclude Include="..\..\..\source\slang-capture-replay\slang-type-conformance.h" />
     <ClInclude Include="..\..\..\source\slang\slang-artifact-output-util.h" />
     <ClInclude Include="..\..\..\source\slang\slang-ast-all.h" />
     <ClInclude Include="..\..\..\source\slang\slang-ast-base.h" />
@@ -543,9 +547,13 @@ IF EXIST ..\..\..\external\slang-glslang\bin\windows-aarch64\release\slang-glsla
     <ClCompile Include="..\..\..\prelude\slang-hlsl-prelude.h.cpp" />
     <ClCompile Include="..\..\..\prelude\slang-torch-prelude.h.cpp" />
     <ClCompile Include="..\..\..\source\slang-capture-replay\capture_utility.cpp" />
+    <ClCompile Include="..\..\..\source\slang-capture-replay\slang-composite-component-type.cpp" />
+    <ClCompile Include="..\..\..\source\slang-capture-replay\slang-entrypoint.cpp" />
     <ClCompile Include="..\..\..\source\slang-capture-replay\slang-filesystem.cpp" />
     <ClCompile Include="..\..\..\source\slang-capture-replay\slang-global-session.cpp" />
+    <ClCompile Include="..\..\..\source\slang-capture-replay\slang-module.cpp" />
     <ClCompile Include="..\..\..\source\slang-capture-replay\slang-session.cpp" />
+    <ClCompile Include="..\..\..\source\slang-capture-replay\slang-type-conformance.cpp" />
     <ClCompile Include="..\..\..\source\slang\slang-api.cpp" />
     <ClCompile Include="..\..\..\source\slang\slang-artifact-output-util.cpp" />
     <ClCompile Include="..\..\..\source\slang\slang-ast-base.cpp" />
diff --git a/build/visual-studio/slang/slang.vcxproj.filters b/build/visual-studio/slang/slang.vcxproj.filters
index 05b9cd2a6..9225f220e 100644
--- a/build/visual-studio/slang/slang.vcxproj.filters
+++ b/build/visual-studio/slang/slang.vcxproj.filters
@@ -15,15 +15,27 @@
     <ClInclude Include="..\..\..\source\slang-capture-replay\capture_utility.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\source\slang-capture-replay\slang-composite-component-type.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
+    <ClInclude Include="..\..\..\source\slang-capture-replay\slang-entrypoint.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\source\slang-capture-replay\slang-filesystem.h">
       <Filter>Header Files</Filter>
     </ClInclude>
     <ClInclude Include="..\..\..\source\slang-capture-replay\slang-global-session.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\source\slang-capture-replay\slang-module.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\source\slang-capture-replay\slang-session.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\source\slang-capture-replay\slang-type-conformance.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\source\slang\slang-artifact-output-util.h">
       <Filter>Header Files</Filter>
     </ClInclude>
@@ -713,15 +725,27 @@
     <ClCompile Include="..\..\..\source\slang-capture-replay\capture_utility.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\source\slang-capture-replay\slang-composite-component-type.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
+    <ClCompile Include="..\..\..\source\slang-capture-replay\slang-entrypoint.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\source\slang-capture-replay\slang-filesystem.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
     <ClCompile Include="..\..\..\source\slang-capture-replay\slang-global-session.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\source\slang-capture-replay\slang-module.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\source\slang-capture-replay\slang-session.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\source\slang-capture-replay\slang-type-conformance.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\source\slang\slang-api.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-- 
cgit v1.2.3