Remove CompileResult to use IArtifact (#2357)

* #include an absolute path didn't work - because paths were taken to always be relative.

* WIP with hierarchical enums.

* Some small fixes and improvements around artifact desc related types.

* Improvements around hierarchical enum.

* Fixes to get Artifact types refactor to be able to execute tests.

* Attempt to better categorize PTX.

* Work around for potentially unused function warning.

* Typo fix.

* Simplify Artifact header.

* Small improvements around Artifact kind/payload/style.

* Added IDestroyable/ICastable

* Add IArtifactList.

* First impl of IArtifactUtil.

* Use the ICastable interface for IArtifactRepresentation.

* Added IArtifactRepresentation & IArtifactAssociated.

* Add SLANG_OVERRIDE to avoid gcc/clang warning.

* Fix calling convention issue on win32.

* Fix missing SLANG_OVERRIDE.

* First attempt at file abstraction around Artifact.

* Added creation of lock file.

* Move functionality for determining file paths to the IArtifactUtil.
Add casting to ICastable.

* Added some casting/finding mechanisms.

* Simplify IArtifact interface, and use Items for file reps.

* Fix problem with libraries on DXIL.

* Split out ArtifactRepresentation.

* Move ArtifactDesc functionality to ArtifactDescUtil. ArtifactInfoUtil becomes ArtifactDescUtil.

* Split implementations from the interfaces for Artifact.

* Use TypeTextUtil for target name outputting.

* Add artifact impls.

* Add ICastableList

* Added UnknownCastableAdapter

* Make ISlangSharedLibrary derive from ICastable, and remain backwards compatible with slang-llvm.

* Refactor Representation on Artifact.

* Make our ISlangBlobs also derive from ICastable.
Make ISlangBlob atomic ref counted.

* Split out CastableList and related types, and placed in core.

* Small fixes around IArtifact.
Improve IArtifact docs.
First impl of getChildren for IArtifact.

* Documentation improvements for Artifact related types.

* Fix typo.

* Special case adding a ICastableList to a LazyCastableList.

* Small simplification of LazyCastableList, by adding State member.

* Removed the ILockFile interface because IFileArtifactRepresentation can be used.

* Implement DiagnosticsArtifactRepresentation.

* Added PostEmitMetadataArtifactRepresentation

* Add searching by predicate.
Added handling of accessing Artifact as ISharedLibrary

* Fix typo.

* Add find to IArtifacgtList.
Fix some missing SLANG_NO_THROW.

* Small improvements around ArtifactDesc types.

* Another small change around ArtifactKind.

* Some more shuffling of ArtifactDesc.

* Make IArtifact castable
Remove IArtifactList
Made IArtifactContainer derive from IArtifact
Made ModuleLibrary atomic ref counted/given IModuleLibrary interface.

* Must call _requireChildren before any children access.

* Fix missing SLANG_MCALL on castAs.

* Fix missing SLANG_OVERRIDE.

* Added IArtifactHandler

* Use ICastable for basis of scope/lookup.

* WIP first attempt to remove CompileResult.

* Fix support for for downstream compiler shared library adapter.

* Fix issues found when replacing CompileResult.

* Fix typo.

* Fix getting items form 'significant' member of an Artifact.

* Split out ArtifactUtil & ArtifactHandler.

* Work around for problem on Visual studio.

* Improve searching.

* Add missing files.

1 files changed, 83 insertions, 52 deletions

diff --git a/source/slang/slang.cpp b/source/slang/slang.cpp
index c0c7c4f5a..6515dc35d 100644
--- a/source/slang/slang.cpp
+++ b/source/slang/slang.cpp
@@ -10,6 +10,7 @@
 // Artifact
 #include "../compiler-core/slang-artifact-impl.h"
 #include "../compiler-core/slang-artifact-desc-util.h"
+#include "../compiler-core/slang-artifact-util.h"
 
 #include "slang-module-library.h"
 
@@ -3151,16 +3152,20 @@ SLANG_NO_THROW SlangResult SLANG_MCALL ComponentType::getEntryPointCode(
     auto targetProgram = getTargetProgram(target);
 
     DiagnosticSink sink(linkage->getSourceManager(), Lexer::sourceLocationLexer);
-    auto& entryPointResult = targetProgram->getOrCreateEntryPointResult(entryPointIndex, &sink);
+
+    IArtifact* entryPointResult = targetProgram->getOrCreateEntryPointResult(entryPointIndex, &sink);
     sink.getBlobIfNeeded(outDiagnostics);
 
-    if(entryPointResult.format == ResultFormat::None )
+    if(entryPointResult == nullptr)
         return SLANG_FAIL;
 
-    ComPtr<ISlangBlob> blob;
-    SLANG_RETURN_ON_FAIL(entryPointResult.getBlob(blob));
-    *outCode = blob.detach();
-    return SLANG_OK;
+    IArtifact* significantBlob = ArtifactUtil::findSignificant(entryPointResult);
+    if (!significantBlob)
+    {
+        return SLANG_FAIL;
+    }
+
+    return significantBlob->loadBlob(ArtifactKeep::Yes, outCode);
 }
 
 SLANG_NO_THROW SlangResult SLANG_MCALL ComponentType::getEntryPointHostCallable(
@@ -3177,17 +3182,13 @@ SLANG_NO_THROW SlangResult SLANG_MCALL ComponentType::getEntryPointHostCallable(
     auto targetProgram = getTargetProgram(target);
 
     DiagnosticSink sink(linkage->getSourceManager(), Lexer::sourceLocationLexer);
-    auto& entryPointResult = targetProgram->getOrCreateEntryPointResult(entryPointIndex, &sink);
+    IArtifact* artifact = targetProgram->getOrCreateEntryPointResult(entryPointIndex, &sink);
     sink.getBlobIfNeeded(outDiagnostics);
 
-    if(entryPointResult.format == ResultFormat::None )
+    if(artifact == nullptr)
         return SLANG_FAIL;
 
-    ComPtr<ISlangSharedLibrary> sharedLibrary;
-    SLANG_RETURN_ON_FAIL(entryPointResult.getSharedLibrary(sharedLibrary));
-
-    *outSharedLibrary = sharedLibrary.detach();
-    return SLANG_OK;
+    return artifact->loadSharedLibrary(ArtifactKeep::Yes, outSharedLibrary);
 }
 
 RefPtr<ComponentType> ComponentType::specialize(
@@ -4757,10 +4758,14 @@ void const* EndToEndCompileRequest::getEntryPointCode(int entryPointIndex, size_
     auto targetProgram = program->getTargetProgram(targetReq);
     if (!targetProgram)
         return nullptr;
-    CompileResult& result = targetProgram->getExistingEntryPointResult(entryPointIndex);
+    IArtifact* artifact = targetProgram->getExistingEntryPointResult(entryPointIndex);
+    if (!artifact)
+    {
+        return nullptr;
+    }
 
     ComPtr<ISlangBlob> blob;
-    SLANG_RETURN_NULL_ON_FAIL(result.getBlob(blob));
+    SLANG_RETURN_NULL_ON_FAIL(artifact->loadBlob(ArtifactKeep::Yes, blob.writeRef()));
 
     if (outSize)
     {
@@ -4774,7 +4779,7 @@ static SlangResult _getEntryPointResult(
     EndToEndCompileRequest* req,
     int                     entryPointIndex,
     int                     targetIndex,
-    Slang::CompileResult**  outCompileResult)
+    ComPtr<IArtifact>&      outArtifact)
 {
     auto linkage = req->getLinkage();
     auto program = req->getSpecializedGlobalAndEntryPointsComponentType();
@@ -4793,18 +4798,18 @@ static SlangResult _getEntryPointResult(
     }
     auto entryPointReq = program->getEntryPoint(entryPointIndex);
 
-
     auto targetProgram = program->getTargetProgram(targetReq);
     if (!targetProgram)
         return SLANG_FAIL;
-    *outCompileResult = &targetProgram->getExistingEntryPointResult(entryPointIndex);
+
+    outArtifact = targetProgram->getExistingEntryPointResult(entryPointIndex);
     return SLANG_OK;
 }
 
 static SlangResult _getWholeProgramResult(
     EndToEndCompileRequest* req,
     int targetIndex,
-    Slang::CompileResult** outCompileResult)
+    ComPtr<IArtifact>& outArtifact)
 {
     auto linkage = req->getLinkage();
     auto program = req->getSpecializedGlobalAndEntryPointsComponentType();
@@ -4824,34 +4829,34 @@ static SlangResult _getWholeProgramResult(
     auto targetProgram = program->getTargetProgram(targetReq);
     if (!targetProgram)
         return SLANG_FAIL;
-    *outCompileResult = &targetProgram->getExistingWholeProgramResult();
+    outArtifact = targetProgram->getExistingWholeProgramResult();
     return SLANG_OK;
 }
 
 SlangResult EndToEndCompileRequest::getEntryPointCodeBlob(int entryPointIndex, int targetIndex, ISlangBlob** outBlob)
 {
     if (!outBlob) return SLANG_E_INVALID_ARG;
-
-    CompileResult* compileResult = nullptr;
-    SLANG_RETURN_ON_FAIL(_getEntryPointResult(this, entryPointIndex, targetIndex, &compileResult));
-
-    ComPtr<ISlangBlob> blob;
-    SLANG_RETURN_ON_FAIL(compileResult->getBlob(blob));
-    *outBlob = blob.detach();
-    return SLANG_OK;
+    ComPtr<IArtifact> artifact;
+    SLANG_RETURN_ON_FAIL(_getEntryPointResult(this, entryPointIndex, targetIndex, artifact));
+    if (auto significant = ArtifactUtil::findSignificant(artifact))
+    {
+        SLANG_RETURN_ON_FAIL(significant->loadBlob(ArtifactKeep::Yes, outBlob));
+        return SLANG_OK;
+    }
+    return SLANG_E_NOT_AVAILABLE;
 }
 
 SlangResult EndToEndCompileRequest::getEntryPointHostCallable(int entryPointIndex, int targetIndex, ISlangSharedLibrary** outSharedLibrary)
 {
     if (!outSharedLibrary) return SLANG_E_INVALID_ARG;
-
-    CompileResult* compileResult = nullptr;
-    SLANG_RETURN_ON_FAIL(_getEntryPointResult(this, entryPointIndex, targetIndex, &compileResult));
-
-    ComPtr<ISlangSharedLibrary> sharedLibrary;
-    SLANG_RETURN_ON_FAIL(compileResult->getSharedLibrary(sharedLibrary));
-    *outSharedLibrary = sharedLibrary.detach();
-    return SLANG_OK;
+    ComPtr<IArtifact> artifact;
+    SLANG_RETURN_ON_FAIL(_getEntryPointResult(this, entryPointIndex, targetIndex, artifact));
+    if (auto significant = ArtifactUtil::findSignificant(artifact))
+    {
+        SLANG_RETURN_ON_FAIL(significant->loadSharedLibrary(ArtifactKeep::Yes, outSharedLibrary));
+        return SLANG_OK;
+    }
+    return SLANG_E_NOT_AVAILABLE;
 }
 
 SlangResult EndToEndCompileRequest::getTargetCodeBlob(int targetIndex, ISlangBlob** outBlob)
@@ -4859,13 +4864,15 @@ SlangResult EndToEndCompileRequest::getTargetCodeBlob(int targetIndex, ISlangBlo
     if (!outBlob)
         return SLANG_E_INVALID_ARG;
 
-    CompileResult* compileResult = nullptr;
-    SLANG_RETURN_ON_FAIL(_getWholeProgramResult(this, targetIndex, &compileResult));
+    ComPtr<IArtifact> artifact;
+    SLANG_RETURN_ON_FAIL(_getWholeProgramResult(this, targetIndex, artifact));
 
-    ComPtr<ISlangBlob> blob;
-    SLANG_RETURN_ON_FAIL(compileResult->getBlob(blob));
-    *outBlob = blob.detach();
-    return SLANG_OK;
+    if (auto significant = ArtifactUtil::findSignificant(artifact))
+    {
+        SLANG_RETURN_ON_FAIL(significant->loadBlob(ArtifactKeep::Yes, outBlob));
+        return SLANG_OK;
+    }
+    return SLANG_E_NOT_AVAILABLE;
 }
 
 SlangResult EndToEndCompileRequest::getTargetHostCallable(int targetIndex,ISlangSharedLibrary** outSharedLibrary)
@@ -4873,12 +4880,9 @@ SlangResult EndToEndCompileRequest::getTargetHostCallable(int targetIndex,ISlang
     if (!outSharedLibrary)
         return SLANG_E_INVALID_ARG;
 
-    CompileResult* compileResult = nullptr;
-    SLANG_RETURN_ON_FAIL(_getWholeProgramResult(this, targetIndex, &compileResult));
-
-    ComPtr<ISlangSharedLibrary> sharedLibrary;
-    SLANG_RETURN_ON_FAIL(compileResult->getSharedLibrary(sharedLibrary));
-    *outSharedLibrary = sharedLibrary.detach();
+    ComPtr<IArtifact> artifact;
+    SLANG_RETURN_ON_FAIL(_getWholeProgramResult(this, targetIndex, artifact));
+    SLANG_RETURN_ON_FAIL(artifact->loadSharedLibrary(ArtifactKeep::Yes, outSharedLibrary));
     return SLANG_OK;
 }
 
@@ -5019,12 +5023,39 @@ SlangResult EndToEndCompileRequest::getEntryPoint(SlangInt entryPointIndex, slan
 
 SlangResult EndToEndCompileRequest::isParameterLocationUsed(Int entryPointIndex, Int targetIndex, SlangParameterCategory category, UInt spaceIndex, UInt registerIndex, bool& outUsed)
 {
-    CompileResult* compileResult = nullptr;
-    if (_getEntryPointResult(this, static_cast<int>(entryPointIndex), static_cast<int>(targetIndex), &compileResult) != SLANG_OK)
+    if (!ShaderBindingRange::isUsageTracked((slang::ParameterCategory)category))
+        return SLANG_E_NOT_AVAILABLE;
+
+    ComPtr<IArtifact> artifact;
+    if (SLANG_FAILED(_getEntryPointResult(this, static_cast<int>(entryPointIndex), static_cast<int>(targetIndex), artifact)))
         return SLANG_E_INVALID_ARG;
 
-    return compileResult->isParameterLocationUsed(category, spaceIndex, registerIndex, outUsed);
-}
+    // We need to find the meta data
+    IArtifact* metadataArtifact = artifact->findArtifactByDerivedDesc(IArtifact::FindStyle::SelfOrChildren,
+        ArtifactDesc::make(ArtifactKind::Base, ArtifactPayload::PostEmitMetadata, ArtifactStyle::Base));
+    if (!metadataArtifact)
+    {
+        return SLANG_E_NOT_AVAILABLE;
+    }
+
+    // Find a rep
+    auto metadataRep = findRepresentation<IPostEmitMetadataArtifactRepresentation>(metadataArtifact);
+    if (!metadataRep)
+        return SLANG_E_NOT_AVAILABLE;
 
+    
+    // TODO: optimize this with a binary search through a sorted list
+    for (const auto& range : metadataRep->getBindingRanges())
+    {
+        if (range.containsBinding((slang::ParameterCategory)category, spaceIndex, registerIndex))
+        {
+            outUsed = true;
+            return SLANG_OK;
+        }
+    }
+
+    outUsed = false;
+    return SLANG_OK;
+}
 
 } // namespace Slang