xref: /third_party/skia/src/sksl/SkSLThreadContext.cpp

/*
 * Copyright 2020 Google LLC
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#include "src/sksl/SkSLThreadContext.h"

#include "include/sksl/DSLSymbols.h"
#if !defined(SKSL_STANDALONE) && SK_SUPPORT_GPU
#include "src/gpu/glsl/GrGLSLFragmentShaderBuilder.h"
#endif // !defined(SKSL_STANDALONE) && SK_SUPPORT_GPU
#include "src/sksl/SkSLCompiler.h"
#include "src/sksl/SkSLIntrinsicMap.h"
#include "src/sksl/ir/SkSLExternalFunction.h"

namespace SkSL {

ThreadContext::ThreadContext(SkSL::Compiler* compiler, SkSL::ProgramKind kind,
        const SkSL::ProgramSettings& settings, SkSL::ParsedModule module, bool isModule)
    : fCompiler(compiler)
    , fOldErrorReporter(*fCompiler->fContext->fErrors)
    , fSettings(settings) {
    fOldModifiersPool = fCompiler->fContext->fModifiersPool;

    fOldConfig = fCompiler->fContext->fConfig;

    if (!isModule) {
        if (compiler->context().fCaps.useNodePools() && settings.fDSLUseMemoryPool) {
            fPool = Pool::Create();
            fPool->attachToThread();
        }
        fModifiersPool = std::make_unique<SkSL::ModifiersPool>();
        fCompiler->fContext->fModifiersPool = fModifiersPool.get();
    }

    fConfig = std::make_unique<SkSL::ProgramConfig>();
    fConfig->fKind = kind;
    fConfig->fSettings = settings;
    fConfig->fIsBuiltinCode = isModule;
    fCompiler->fContext->fConfig = fConfig.get();
    fCompiler->fContext->fErrors = &fDefaultErrorReporter;
    fCompiler->fContext->fIntrinsics = module.fIntrinsics.get();
    if (fCompiler->fContext->fIntrinsics) {
        fCompiler->fContext->fIntrinsics->resetAlreadyIncluded();
    }

    fCompiler->fSymbolTable = module.fSymbols;
    this->setupSymbolTable();
}

ThreadContext::~ThreadContext() {
    if (SymbolTable()) {
        fCompiler->fSymbolTable = nullptr;
        fProgramElements.clear();
    } else {
        // We should only be here with a null symbol table if ReleaseProgram was called
        SkASSERT(fProgramElements.empty());
    }
    fCompiler->fContext->fErrors = &fOldErrorReporter;
    fCompiler->fContext->fConfig = fOldConfig;
    fCompiler->fContext->fModifiersPool = fOldModifiersPool;
    if (fPool) {
        fPool->detachFromThread();
    }
}

void ThreadContext::setupSymbolTable() {
    SkSL::Context& context = *fCompiler->fContext;
    SymbolTable::Push(&fCompiler->fSymbolTable, context.fConfig->fIsBuiltinCode);
    SkSL::SymbolTable& symbols = *fCompiler->fSymbolTable;

    if (fSettings.fExternalFunctions) {
        // Add any external values to the new symbol table, so they're only visible to this Program.
        for (const std::unique_ptr<ExternalFunction>& ef : *fSettings.fExternalFunctions) {
            symbols.addWithoutOwnership(ef.get());
        }
    }

    bool runtimeEffect = ProgramConfig::IsRuntimeEffect(context.fConfig->fKind);
    if (runtimeEffect && !context.fConfig->fSettings.fEnforceES2Restrictions) {
        // We're compiling a runtime effect, but we're not enforcing ES2 restrictions. Add various
        // non-ES2 types to our symbol table to allow them to be tested.
        symbols.addAlias("mat2x2", context.fTypes.fFloat2x2.get());
        symbols.addAlias("mat2x3", context.fTypes.fFloat2x3.get());
        symbols.addAlias("mat2x4", context.fTypes.fFloat2x4.get());
        symbols.addAlias("mat3x2", context.fTypes.fFloat3x2.get());
        symbols.addAlias("mat3x3", context.fTypes.fFloat3x3.get());
        symbols.addAlias("mat3x4", context.fTypes.fFloat3x4.get());
        symbols.addAlias("mat4x2", context.fTypes.fFloat4x2.get());
        symbols.addAlias("mat4x3", context.fTypes.fFloat4x3.get());
        symbols.addAlias("mat4x4", context.fTypes.fFloat4x4.get());

        symbols.addAlias("float2x3", context.fTypes.fFloat2x3.get());
        symbols.addAlias("float2x4", context.fTypes.fFloat2x4.get());
        symbols.addAlias("float3x2", context.fTypes.fFloat3x2.get());
        symbols.addAlias("float3x4", context.fTypes.fFloat3x4.get());
        symbols.addAlias("float4x2", context.fTypes.fFloat4x2.get());
        symbols.addAlias("float4x3", context.fTypes.fFloat4x3.get());

        symbols.addAlias("half2x3", context.fTypes.fHalf2x3.get());
        symbols.addAlias("half2x4", context.fTypes.fHalf2x4.get());
        symbols.addAlias("half3x2", context.fTypes.fHalf3x2.get());
        symbols.addAlias("half3x4", context.fTypes.fHalf3x4.get());
        symbols.addAlias("half4x2", context.fTypes.fHalf4x2.get());
        symbols.addAlias("half4x3", context.fTypes.fHalf4x3.get());

        symbols.addAlias("uint", context.fTypes.fUInt.get());
        symbols.addAlias("uint2", context.fTypes.fUInt2.get());
        symbols.addAlias("uint3", context.fTypes.fUInt3.get());
        symbols.addAlias("uint4", context.fTypes.fUInt4.get());

        symbols.addAlias("short", context.fTypes.fShort.get());
        symbols.addAlias("short2", context.fTypes.fShort2.get());
        symbols.addAlias("short3", context.fTypes.fShort3.get());
        symbols.addAlias("short4", context.fTypes.fShort4.get());

        symbols.addAlias("ushort", context.fTypes.fUShort.get());
        symbols.addAlias("ushort2", context.fTypes.fUShort2.get());
        symbols.addAlias("ushort3", context.fTypes.fUShort3.get());
        symbols.addAlias("ushort4", context.fTypes.fUShort4.get());
    }
}

SkSL::Context& ThreadContext::Context() {
    return Compiler().context();
}

SkSL::ProgramSettings& ThreadContext::Settings() {
    return Context().fConfig->fSettings;
}

std::shared_ptr<SkSL::SymbolTable>& ThreadContext::SymbolTable() {
    return Compiler().fSymbolTable;
}

const SkSL::Modifiers* ThreadContext::Modifiers(const SkSL::Modifiers& modifiers) {
    return Context().fModifiersPool->add(modifiers);
}

ThreadContext::RTAdjustData& ThreadContext::RTAdjustState() {
    return Instance().fRTAdjust;
}

#if !defined(SKSL_STANDALONE) && SK_SUPPORT_GPU
void ThreadContext::StartFragmentProcessor(GrFragmentProcessor::ProgramImpl* processor,
        GrFragmentProcessor::ProgramImpl::EmitArgs* emitArgs) {
    ThreadContext& instance = ThreadContext::Instance();
    instance.fStack.push({processor, emitArgs, StatementArray{}});
    CurrentEmitArgs()->fFragBuilder->fDeclarations.swap(instance.fStack.top().fSavedDeclarations);
    dsl::PushSymbolTable();
}

void ThreadContext::EndFragmentProcessor() {
    ThreadContext& instance = Instance();
    SkASSERT(!instance.fStack.empty());
    CurrentEmitArgs()->fFragBuilder->fDeclarations.swap(instance.fStack.top().fSavedDeclarations);
    instance.fStack.pop();
    dsl::PopSymbolTable();
}
#endif // !defined(SKSL_STANDALONE) && SK_SUPPORT_GPU

void ThreadContext::SetErrorReporter(ErrorReporter* errorReporter) {
    SkASSERT(errorReporter);
    Context().fErrors = errorReporter;
}

void ThreadContext::ReportError(skstd::string_view msg, PositionInfo info) {
    GetErrorReporter().error(msg, info);
}

void ThreadContext::DefaultErrorReporter::handleError(skstd::string_view msg, PositionInfo pos) {
    if (pos.line() > -1) {
        SK_ABORT("error: %s: %d: %.*sNo SkSL error reporter configured, treating this as a fatal "
                 "error\n", pos.file_name(), pos.line(), (int)msg.length(), msg.data());
    } else {
        SK_ABORT("error: %.*s\nNo SkSL error reporter configured, treating this as a fatal error\n",
                 (int)msg.length(), msg.data());
    }

}

void ThreadContext::ReportErrors(PositionInfo pos) {
    GetErrorReporter().reportPendingErrors(pos);
}

thread_local ThreadContext* instance = nullptr;

bool ThreadContext::IsActive() {
    return instance != nullptr;
}

ThreadContext& ThreadContext::Instance() {
    SkASSERTF(instance, "dsl::Start() has not been called");
    return *instance;
}

void ThreadContext::SetInstance(std::unique_ptr<ThreadContext> newInstance) {
    SkASSERT((instance == nullptr) != (newInstance == nullptr));
    delete instance;
    instance = newInstance.release();
}

} // namespace SkSL