nsight Aftermath crash example (#2984)

* Small fixes and improvements around reflection tool.

* Make PrettyWriter printing a class.

* Aftermath crash demo WIP.

* Enable aftermath in test project.

* Setting failCount.

* Dumping out of source maps.

* Improve comments.
Simplify handling of compile products.

* Other small fixes to aftermath example.

* Added Emit SourceLocType.
Track sourcemap association meaning.
Improved documentation.

* Small improvements.

* Capture debug information for D3D11/D3D12/Vulkan.

* Enable debug info.

* Small improvements.

* Improve aftermath example README.md.

4 files changed, 134 insertions, 4 deletions

diff --git a/source/slang/slang-compiler.h b/source/slang/slang-compiler.h
index ca16bfb94..7d73599ba 100755
--- a/source/slang/slang-compiler.h
+++ b/source/slang/slang-compiler.h
@@ -297,6 +297,12 @@ namespace Slang
             SlangInt        targetIndex,
             slang::IBlob**  outCode,
             slang::IBlob**  outDiagnostics) SLANG_OVERRIDE;
+
+        SLANG_NO_THROW SlangResult SLANG_MCALL getResultAsFileSystem(
+            SlangInt    entryPointIndex,
+            SlangInt    targetIndex,
+            ISlangMutableFileSystem** outFileSystem) SLANG_OVERRIDE;
+
         SLANG_NO_THROW SlangResult SLANG_MCALL specialize(
             slang::SpecializationArg const* specializationArgs,
             SlangInt                        specializationArgCount,
@@ -851,6 +857,14 @@ namespace Slang
             return Super::getEntryPointCode(entryPointIndex, targetIndex, outCode, outDiagnostics);
         }
 
+        SLANG_NO_THROW SlangResult SLANG_MCALL getResultAsFileSystem(
+            SlangInt        entryPointIndex,
+            SlangInt        targetIndex,
+            ISlangMutableFileSystem** outFileSystem)  SLANG_OVERRIDE
+        {
+            return Super::getResultAsFileSystem(entryPointIndex, targetIndex, outFileSystem);
+        }
+
         SLANG_NO_THROW SlangResult SLANG_MCALL specialize(
             slang::SpecializationArg const* specializationArgs,
             SlangInt                        specializationArgCount,
@@ -1067,6 +1081,14 @@ namespace Slang
             return Super::getEntryPointCode(entryPointIndex, targetIndex, outCode, outDiagnostics);
         }
 
+        SLANG_NO_THROW SlangResult SLANG_MCALL getResultAsFileSystem(
+            SlangInt        entryPointIndex,
+            SlangInt        targetIndex,
+            ISlangMutableFileSystem** outFileSystem)  SLANG_OVERRIDE
+        {
+            return Super::getResultAsFileSystem(entryPointIndex, targetIndex, outFileSystem);
+        }
+
         SLANG_NO_THROW SlangResult SLANG_MCALL specialize(
             slang::SpecializationArg const* specializationArgs,
             SlangInt specializationArgCount,
@@ -1221,6 +1243,14 @@ namespace Slang
             return Super::getEntryPointCode(entryPointIndex, targetIndex, outCode, outDiagnostics);
         }
 
+        SLANG_NO_THROW SlangResult SLANG_MCALL getResultAsFileSystem(
+            SlangInt        entryPointIndex,
+            SlangInt        targetIndex,
+            ISlangMutableFileSystem** outFileSystem)  SLANG_OVERRIDE
+        {
+            return Super::getResultAsFileSystem(entryPointIndex, targetIndex, outFileSystem);
+        }
+
         SLANG_NO_THROW SlangResult SLANG_MCALL specialize(
             slang::SpecializationArg const* specializationArgs,
             SlangInt                        specializationArgCount,
diff --git a/source/slang/slang-emit-source-writer.cpp b/source/slang/slang-emit-source-writer.cpp
index 72696c94a..4ff547119 100644
--- a/source/slang/slang-emit-source-writer.cpp
+++ b/source/slang/slang-emit-source-writer.cpp
@@ -311,7 +311,7 @@ void SourceWriter::advanceToSourceLocation(const SourceLoc& sourceLocation)
     }
 
     // Workout the humane source location.
-    const HumaneSourceLoc humaneSourceLoc = getSourceManager()->getHumaneLoc(sourceLocation);
+    const HumaneSourceLoc humaneSourceLoc = getSourceManager()->getHumaneLoc(sourceLocation, SourceLocType::Emit);
 
     // If the location is valid, mark need to update, and the new location
     if (humaneSourceLoc.line > 0)
diff --git a/source/slang/slang-ir-obfuscate-loc.cpp b/source/slang/slang-ir-obfuscate-loc.cpp
index ecc16d2b2..860633106 100644
--- a/source/slang/slang-ir-obfuscate-loc.cpp
+++ b/source/slang/slang-ir-obfuscate-loc.cpp
@@ -362,8 +362,8 @@ SlangResult obfuscateModuleLocs(IRModule* module, SourceManager* sourceManager)
         sourceMap->addEntry(entries[i]);
     }
 
-    // Associate the sourceMap with the obfuscated file
-    obfuscatedFile->setSourceMap(boxedSourceMap);
+    // Associate the sourceMap with the obfuscated file. 
+    obfuscatedFile->setSourceMap(boxedSourceMap, SourceMapKind::Obfuscated);
 
     // Set the obfuscated map onto the module
     module->setObfuscatedSourceMap(boxedSourceMap);
diff --git a/source/slang/slang.cpp b/source/slang/slang.cpp
index 760a119d1..e08bb2a62 100644
--- a/source/slang/slang.cpp
+++ b/source/slang/slang.cpp
@@ -3464,6 +3464,106 @@ SLANG_NO_THROW slang::ProgramLayout* SLANG_MCALL ComponentType::getLayout(
     return asExternal(programLayout);
 }
 
+static ICastable* _findDiagnosticRepresentation(IArtifact* artifact)
+{
+    if (auto rep = findAssociatedRepresentation<IArtifactDiagnostics>(artifact))
+    {
+        return rep;
+    }
+
+    for (auto associated : artifact->getAssociated())
+    {
+        if (isDerivedFrom(associated->getDesc().payload, ArtifactPayload::Diagnostics))
+        {
+            return associated;
+        }
+    }
+    return nullptr;
+}
+
+static IArtifact* _findObfuscatedSourceMap(IArtifact* artifact)
+{
+    // If we find any obfuscated source maps, we are done
+    for (auto associated : artifact->getAssociated())
+    {
+        const auto desc = associated->getDesc();
+
+        if (isDerivedFrom(desc.payload, ArtifactPayload::SourceMap) &&
+            isDerivedFrom(desc.style, ArtifactStyle::Obfuscated))
+        {
+            return associated;        
+        }
+    }
+    return nullptr;
+}
+
+SLANG_NO_THROW SlangResult SLANG_MCALL ComponentType::getResultAsFileSystem(
+    SlangInt        entryPointIndex,
+    Int             targetIndex,
+    ISlangMutableFileSystem** outFileSystem)
+{
+    ComPtr<ISlangBlob> diagnostics;
+    ComPtr<ISlangBlob> code;
+
+    SLANG_RETURN_ON_FAIL(getEntryPointCode(entryPointIndex, targetIndex, diagnostics.writeRef(), code.writeRef()));
+
+    auto linkage = getLinkage();
+
+    auto target = linkage->targets[targetIndex];
+
+    auto targetProgram = getTargetProgram(target);
+
+    IArtifact* artifact = targetProgram->getExistingEntryPointResult(entryPointIndex);
+    
+    // Add diagnostics id needs be...
+    if (diagnostics && !_findDiagnosticRepresentation(artifact))
+    {
+        // Add as an associated 
+
+        auto diagnosticsArtifact = Artifact::create(ArtifactDesc::make(Artifact::Kind::HumanText, ArtifactPayload::Diagnostics));
+        diagnosticsArtifact->addRepresentationUnknown(diagnostics);
+
+        artifact->addAssociated(diagnosticsArtifact);
+
+        SLANG_ASSERT(diagnosticsArtifact == _findDiagnosticRepresentation(artifact));
+    }
+
+    // Add obfuscated source maps
+    if (!_findObfuscatedSourceMap(artifact))
+    {
+        List<IRModule*> irModules;
+        enumerateIRModules([&](IRModule* irModule) -> void { irModules.add(irModule); });
+
+        for (auto irModule : irModules)
+        {
+            if (auto obfuscatedSourceMap = irModule->getObfuscatedSourceMap())
+            {
+                auto artifactDesc = ArtifactDesc::make(ArtifactKind::Json, ArtifactPayload::SourceMap, ArtifactStyle::Obfuscated);
+
+                // Create the source map artifact
+                auto sourceMapArtifact = Artifact::create(artifactDesc, obfuscatedSourceMap->get().m_file.getUnownedSlice());
+
+                sourceMapArtifact->addRepresentation(obfuscatedSourceMap);
+
+                // associate with the artifact
+                artifact->addAssociated(sourceMapArtifact);
+            }
+        }
+    }
+    
+    // Turn into a file system and return
+    ComPtr<ISlangMutableFileSystem> fileSystem(new MemoryFileSystem);
+
+    // Filter the containerArtifact into things that can be written
+    ComPtr<IArtifact> writeArtifact;
+    SLANG_RETURN_ON_FAIL(ArtifactContainerUtil::filter(artifact, writeArtifact));
+    SLANG_RETURN_ON_FAIL(ArtifactContainerUtil::writeContainer(writeArtifact, "", fileSystem));
+
+    *outFileSystem = fileSystem.detach();
+
+    return SLANG_OK;
+}
+
 SLANG_NO_THROW SlangResult SLANG_MCALL ComponentType::getEntryPointCode(
     SlangInt        entryPointIndex,
     Int             targetIndex,
@@ -4983,7 +5083,7 @@ SlangResult _addLibraryReference(EndToEndCompileRequest* req, IArtifact* artifac
                 if (name.getLength())
                 {
                     auto sourceFile = sourceManager->findSourceFileByPathRecursively(name);
-                    sourceFile->setSourceMap(sourceMap);
+                    sourceFile->setSourceMap(sourceMap, SourceMapKind::Obfuscated);
                 }
             }
         }