Test for link time constants

This test exercises link time constants used by modules that are precompiled to SPIR-V.

Work on shader-slang#6524

Author: cheneym2

source/slang/slang-compiler-tu.cpp

@@ -147,6 +147,8 @@ Module::precompileForTarget(SlangCompileTarget target, slang::IBlob** outDiagnos
     // of function name to IRInst* for later reference. After linking is done, we'll scan
     // the linked result to see which functions survived the pruning and are included in the
     // precompiled blob.
+    // Tenatively mark all imported variables as downstream imported to resolve potential
+    // issues with unresolved symbols in the downstream IR.
     Dictionary<String, IRInst*> nameToFunction;
     bool hasAtLeastOneFunction = false;
     for (auto inst : module->getGlobalInsts())
@@ -157,6 +159,12 @@ Module::precompileForTarget(SlangCompileTarget target, slang::IBlob** outDiagnos
             builder.addDecoration(inst, kIROp_DownstreamModuleExportDecoration);
             nameToFunction[inst->findDecoration<IRExportDecoration>()->getMangledName()] = inst;
         }
+
+        //if (inst->findDecoration<IRImportDecoration>())
+       // {
+        //    inst->dump();
+        //    builder.addDecoration(inst, kIROp_DownstreamModuleImportDecoration);
+       // }
     }
 
     // Bail if there are no functions to export. That's not treated as an error
@@ -170,6 +178,12 @@ Module::precompileForTarget(SlangCompileTarget target, slang::IBlob** outDiagnos
     SlangResult res = codeGenContext.emitPrecompiledDownstreamIR(outArtifact);
 
     sink.getBlobIfNeeded(outDiagnostics);
+
+    // print diagnostics
+    if (outDiagnostics && *outDiagnostics)
+    {
+        fprintf(stderr, "%s", (const char*)outDiagnostics);
+    }
     if (res != SLANG_OK)
     {
         return res;
@@ -212,6 +226,9 @@ Module::precompileForTarget(SlangCompileTarget target, slang::IBlob** outDiagnos
     builder.setInsertInto(module);
 
     builder.emitEmbeddedDownstreamIR(targetReq->getTarget(), blob);
+
+    module->getModuleInst()->dump();
+
     return SLANG_OK;
 }
 

source/slang/slang-emit-spirv.cpp

@@ -1907,6 +1907,9 @@ struct SPIRVEmitContext : public SourceEmitterBase, public SPIRVEmitSharedContex
         case kIROp_IndicesType:
         case kIROp_PrimitivesType:
             return nullptr;
+        case kIROp_GlobalConstant:
+            //return emitGlobalConstant(as<IRGlobalConstant>(inst));
+            return nullptr;
         default:
             {
                 if (as<IRSPIRVAsmOperand>(inst))
@@ -3435,6 +3438,7 @@ struct SPIRVEmitContext : public SourceEmitterBase, public SPIRVEmitSharedContex
     /// Emit an instruction that is local to the body of the given `parent`.
     SpvInst* emitLocalInst(SpvInstParent* parent, IRInst* inst)
     {
+        inst->dump();
         SpvInst* result = nullptr;
         switch (inst->getOp())
         {

source/slang/slang-emit.cpp

@@ -638,9 +638,14 @@ Result linkAndOptimizeIR(
     // modules, and also select between the definitions of
     // any "profile-overloaded" symbols.
     //
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        return SLANG_FAIL;
+
     outLinkedIR = linkIR(codeGenContext);
     auto irModule = outLinkedIR.module;
     auto irEntryPoints = outLinkedIR.entryPoints;
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        return SLANG_FAIL;
 
 #if 0
     dumpIRIfEnabled(codeGenContext, irModule, "LINKED");
@@ -812,6 +817,8 @@ Result linkAndOptimizeIR(
 
     // Lower all the LValue implict casts (used for out/inout/ref scenarios)
     lowerLValueCast(targetProgram, irModule);
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        return SLANG_FAIL;
 
     IRSimplificationOptions defaultIRSimplificationOptions =
         IRSimplificationOptions::getDefault(targetProgram);
@@ -832,6 +839,8 @@ Result linkAndOptimizeIR(
         if (sink->getErrorCount() != 0)
             return SLANG_FAIL;
     }
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        return SLANG_FAIL;
 
     // Fill in default matrix layout into matrix types that left layout unspecified.
     specializeMatrixLayout(targetProgram, irModule);
@@ -883,6 +892,8 @@ Result linkAndOptimizeIR(
     //
     // Specialization passes and auto-diff passes runs in an iterative loop
     // since each pass can enable the other pass to progress further.
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        return SLANG_FAIL;
     for (;;)
     {
         bool changed = false;

source/slang/slang-ir-link.cpp

@@ -1716,6 +1716,8 @@ static bool doesTargetAllowUnresolvedFuncSymbol(TargetRequest* req)
     }
 }
 
+
+
 static void diagnoseUnresolvedSymbols(TargetRequest* req, DiagnosticSink* sink, IRModule* module)
 {
     for (auto globalSym : module->getGlobalInsts())
@@ -1727,10 +1729,17 @@ static void diagnoseUnresolvedSymbols(TargetRequest* req, DiagnosticSink* sink,
                 if (auto constant = as<IRGlobalConstant>(globalSym))
                 {
                     if (constant->getOperandCount() == 0)
+                    {
+                        if (globalSym->findDecoration<IRDownstreamModuleImportDecoration>())
+                        {
+                            break;
+                        }
+                        
                         sink->diagnose(
-                            globalSym->sourceLoc,
-                            Diagnostics::unresolvedSymbol,
-                            globalSym);
+                                globalSym->sourceLoc,
+                                Diagnostics::unresolvedSymbol,
+                                globalSym);                        
+                    }
                 }
                 else if (auto genericSym = as<IRGeneric>(globalSym))
                 {
@@ -2017,14 +2026,16 @@ void cloneUsedWitnessTableEntries(IRSpecContext* context)
 LinkedIR linkIR(CodeGenContext* codeGenContext)
 {
     SLANG_PROFILE;
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     auto linkage = codeGenContext->getLinkage();
     auto program = codeGenContext->getProgram();
     auto session = codeGenContext->getSession();
     auto target = codeGenContext->getTargetFormat();
     auto targetProgram = codeGenContext->getTargetProgram();
     auto targetReq = codeGenContext->getTargetReq();
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // TODO: We need to make sure that the program we are being asked
     // to compile has been "resolved" so that it has no outstanding
     // unsatisfied requirements.
@@ -2035,10 +2046,12 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
     state->target = target;
     state->targetReq = targetReq;
     auto& irModules = stateStorage.contextStorage.irModules;
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     auto sharedContext = state->getSharedContext();
     initializeSharedSpecContext(sharedContext, session, nullptr, target, targetReq);
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     state->irModule = sharedContext->module;
 
     // We need to be able to look up IR definitions for any symbols in
@@ -2050,7 +2063,8 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
     List<IRModule*> builtinModules;
     for (auto& m : globalSession->coreModules)
         builtinModules.add(m->getIRModule());
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // Link modules in the program.
     program->enumerateIRModules(
         [&](IRModule* module)
@@ -2060,7 +2074,8 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
             else
                 irModules.add(module);
         });
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // We will also consider the IR global symbols from the IR module
     // attached to the `TargetProgram`, since this module is
     // responsible for associating layout information to those
@@ -2073,7 +2088,8 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
     Index userModuleCount = irModules.getCount();
     irModules.addRange(builtinModules);
     ArrayView<IRModule*> userModules = irModules.getArrayView(0, userModuleCount);
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // Check if any user module uses auto-diff, if so we will need to link
     // additional witnesses and decorations.
     for (IRModule* irModule : userModules)
@@ -2094,14 +2110,17 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
         }
         addGlobalHashedStringLiterals(pool, state->irModule);
     }
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
+    
     // Set up shared and builder insert point
 
     context->shared = sharedContext;
     context->builder = &sharedContext->builderStorage;
 
     context->builder->setInsertInto(context->getModule()->getModuleInst());
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // Next, we make sure to clone the global value for
     // the entry point function itself, and rely on
     // this step to recursively copy over anything else
@@ -2126,7 +2145,8 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
             entryPoint,
             nameOverride.getUnownedSlice()));
     }
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // Layout information for global shader parameters is also required,
     // and in particular every global parameter that is part of the layout
     // should be present in the initial IR module so that steps that
@@ -2143,7 +2163,8 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
                 cast<IRVarLayout>(cloneValue(context, irOriginalGlobalScopeVarLayout));
         }
     }
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // Bindings for global generic parameters are currently represented
     // as stand-alone global-scope instructions in the IR module for
     // `SpecializedComponentType`s. These instructions are required for
@@ -2167,7 +2188,8 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
             }
         }
     }
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     bool shouldCopyGlobalParams =
         linkage->m_optionSet.getBoolOption(CompilerOptionName::PreserveParameters);
 
@@ -2190,7 +2212,8 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
             }
         }
     }
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // In previous steps, we have skipped cloning the witness table entries, and
     // registered any used witness table entry keys to context->deferredWitnessTableEntryKeys
     // for on-demand cloning. Now we will use the deferred keys to clone the witness table
@@ -2234,21 +2257,25 @@ LinkedIR linkIR(CodeGenContext* codeGenContext)
             }
         }
     }
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // Specialize target_switch branches to use the best branch for the target.
     specializeTargetSwitch(targetReq, state->irModule, codeGenContext->getSink());
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // Diagnose on unresolved symbols if we are compiling into a target that does
     // not allow incomplete symbols.
     // At this point, we should not see any [import] symbols that does not have a
     // definition.
     diagnoseUnresolvedSymbols(targetReq, codeGenContext->getSink(), state->irModule);
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // type-use reformatter of GLSL types (only if compiler is set to AllowGLSL mode)
     // which are not supported by SPIRV->Vulkan but is supported by GLSL->Vulkan through
     // compiler magic tricks
     GLSLReplaceAtomicUint(context, targetProgram, state->irModule);
-
+    if (codeGenContext->getSink()->getErrorCount() != 0)
+        printf("Failed to link IR\n");
     // TODO: *technically* we should consider the case where
     // we have global variables with initializers, since
     // these should get run whether or not the entry point

source/slang/slang-ir.cpp

@@ -8671,6 +8671,10 @@ bool isDefinition(IRInst* inVal)
         return val->getFirstChild() != nullptr;
 
     case kIROp_GlobalConstant:
+        if (cast<IRGlobalConstant>(val)->getValue() == nullptr)
+        {
+            printf("Has no value\n");
+        }
         return cast<IRGlobalConstant>(val)->getValue() != nullptr;
 
     default:

source/slang/slang.cpp

@@ -1429,7 +1429,24 @@ Linkage::loadModule(const char* moduleName, slang::IBlob** outDiagnostics)
         auto name = getNamePool()->getName(moduleName);
 
         auto module = findOrImportModule(name, SourceLoc(), &sink);
+                
         sink.getBlobIfNeeded(outDiagnostics);
+        
+        if (false && module->getInterface(slang::IModulePrecompileService_Experimental::getTypeGuid()))
+        {
+            auto interface = static_cast<slang::IModulePrecompileService_Experimental*>(module);
+            auto res = interface->precompileForTarget(SLANG_SPIRV, outDiagnostics);
+            // diagnose if needed
+            if (outDiagnostics)
+            {
+                sink.diagnoseRaw(Severity::Error, "Failed to precompile module for SPIRV");
+            }
+            if (SLANG_FAILED(res))
+            {
+                return nullptr;
+            }
+            
+        }
 
         return asExternal(module);
     }
@@ -3667,6 +3684,27 @@ void EndToEndCompileRequest::init()
     m_frontEndReq = new FrontEndCompileRequest(getLinkage(), m_writers, getSink());
 }
 
+static void dumpIRIfEnabled(
+    CodeGenContext* codeGenContext,
+    IRModule* irModule,
+    char const* label = nullptr)
+{
+    if (codeGenContext->shouldDumpIR())
+    {
+        DiagnosticSinkWriter writer(codeGenContext->getSink());
+        // FILE* f = nullptr;
+        // fopen_s(&f, (String("dump-") + label + ".txt").getBuffer(), "wt");
+        // FileWriter writer(f, 0);
+        dumpIR(
+            irModule,
+            codeGenContext->getIRDumpOptions(),
+            label,
+            codeGenContext->getSourceManager(),
+            &writer);
+        // fclose(f);
+    }
+}
+
 SlangResult EndToEndCompileRequest::executeActionsInner()
 {
     SLANG_PROFILE_SECTION(endToEndActions);
@@ -3749,6 +3787,8 @@ SlangResult EndToEndCompileRequest::executeActionsInner()
             }
         }
     }
+     
+    
 
     // If codegen is enabled, we need to move along to
     // apply any generic specialization that the user asked for.

tests/library/export-library-global.slang

@@ -0,0 +1,7 @@
+// TEST_IGNORE_FILE
+
+// export-library-global.slang
+
+export static int myGlobalVar = 42;
+
+

tests/library/precompiled-spirv-global.slang

@@ -0,0 +1,12 @@
+//TEST:COMPILE: tests/library/precompiled-spirv-global.slang -o tests/library/precompiled-spirv-global.slang-module -target spirv -embed-downstream-ir
+
+//import "export-library-global.slang";  //This would make the test pass
+
+extern int myGlobalVar; //This makes the test fail
+
+layout(location = 0) out float4 fragColor;
+
+[shader("fragment")]
+void main() {
+    fragColor = float4(myGlobalVar);
+}