Crafter.Build/implementations/Crafter.Build-Shader.cpp

126 lines
5.6 KiB
C++
Raw Normal View History

2026-07-23 01:24:42 +02:00
// SPDX-License-Identifier: LGPL-3.0-only
// SPDX-FileCopyrightText: Copyright (C) 2026 Catcrafts®
2025-10-31 16:50:47 +01:00
module;
2026-03-02 21:11:56 +01:00
#include "SPIRV/GlslangToSpv.h"
#include "glslang/Public/ShaderLang.h"
#include "glslang/Public/ResourceLimits.h"
2025-10-31 16:50:47 +01:00
#include "../lib/DirStackFileIncluder.h"
module Crafter.Build:Shader_impl;
import :Shader;
import std;
namespace fs = std::filesystem;
2026-04-27 07:04:42 +02:00
namespace {
EShLanguage ToEShLanguage(Crafter::ShaderType t) {
switch (t) {
case Crafter::ShaderType::Vertex: return EShLangVertex;
case Crafter::ShaderType::TessControl: return EShLangTessControl;
case Crafter::ShaderType::TessEvaluation: return EShLangTessEvaluation;
case Crafter::ShaderType::Geometry: return EShLangGeometry;
case Crafter::ShaderType::Fragment: return EShLangFragment;
case Crafter::ShaderType::Compute: return EShLangCompute;
case Crafter::ShaderType::RayGen: return EShLangRayGen;
case Crafter::ShaderType::Intersect: return EShLangIntersect;
case Crafter::ShaderType::AnyHit: return EShLangAnyHit;
case Crafter::ShaderType::ClosestHit: return EShLangClosestHit;
case Crafter::ShaderType::Miss: return EShLangMiss;
case Crafter::ShaderType::Callable: return EShLangCallable;
case Crafter::ShaderType::Task: return EShLangTask;
case Crafter::ShaderType::Mesh: return EShLangMesh;
}
return EShLangVertex;
}
}
2025-10-31 16:50:47 +01:00
namespace Crafter {
2026-04-27 07:04:42 +02:00
Shader::Shader(fs::path&& path, std::string&& entrypoint, ShaderType type) : path(std::move(path)), entrypoint(std::move(entrypoint)), type(type) {
2025-10-31 16:50:47 +01:00
}
bool Shader::Check(const fs::path& outputDir) const {
2026-05-01 19:16:13 +02:00
fs::path spv = outputDir / path.filename().replace_extension("spv");
return fs::exists(spv) && fs::last_write_time(path) < fs::last_write_time(spv);
2025-10-31 16:50:47 +01:00
}
2026-05-02 21:08:51 +02:00
std::string Shader::Compile(const fs::path& outputDir, std::span<const fs::path> includeDirs) const {
2026-04-27 07:04:42 +02:00
EShLanguage glslangType = ToEShLanguage(type);
2025-10-31 16:50:47 +01:00
glslang::InitializeProcess();
2026-05-01 19:02:14 +02:00
// Every error path returns a non-empty string; the caller treats
// empty as success (see Crafter.Build-Clang.cpp BuildOnce shader
// worker). Prefixing with the source path is what tells the user
// which shader actually failed when several compile in parallel.
auto fail = [&](std::string_view stage, std::string log) {
glslang::FinalizeProcess();
std::string out = path.string();
out += ": ";
out += stage;
if (!log.empty()) {
out += '\n';
out += log;
}
return out;
};
feat(lint): const-local and constexpr-constant rules Two rules the AST makes possible, plus the mutation analysis behind them. const-local reports a local that is never written. It is restricted to SCALARS — integers, bools, enums, floating types — and that restriction is what makes the answer exact rather than a guess: a scalar has no member functions, so the only ways to write one are assignment, ++/--, having its address taken, or binding to a non-const reference. All four are now tracked in the walk: - assignment and compound assignment visit their LEFT operand in a write context, the right one normally; - ++/-- and & write their operand; - a call argument is checked against the callee's parameter type, so passing to `const int&` or by value is a read while `int&` is a write; - initialising a non-const reference writes what it binds to. For a class type a non-const method call could mutate it, and deciding that is the whole-program analysis clang-tidy does, so those are simply out of scope rather than guessed at. constexpr-constant promotes a const constant whose initialiser is made only of literals and operators, so `const int A = 1 << 4;` qualifies and `const int B = Compute();` does not. On this repository const-local found 103 candidates, which was too many to be useful, and the reason was informative: most were range-for bindings and pointer locals. `for (T* const x : …)` and `T* const p` are not spellings anybody writes, and the useful constness for a pointer is on the pointee, which this rule cannot advise on. Excluding both leaves 36, all plain bool or enum locals worth fixing — isWasm, isPe, exists, writes, isC and so on. Those 36 are fixed in this commit; the compiler verified every one. Both rules are report-only. The analysis is exact, but adding const is a judgement about intent as much as mechanics, and a wrong suggestion should cost a glance rather than a build. const-local also deliberately does not become a transform: inserting `const` before a shared type would apply it to every declarator in a multi-declarator statement, including any that IS written. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-31 00:50:48 +02:00
const EShMessages messages = static_cast<EShMessages>(EShMsgDefault | EShMsgVulkanRules | EShMsgSpvRules);
2025-10-31 16:50:47 +01:00
std::ifstream fileStream(path, std::ios::in | std::ios::binary);
if (!fileStream) {
2026-05-01 19:02:14 +02:00
return fail("failed to open shader source", {});
2025-10-31 16:50:47 +01:00
}
std::ostringstream contents;
contents << fileStream.rdbuf();
std::string src = contents.str();
2026-04-27 07:04:42 +02:00
2026-05-01 19:02:14 +02:00
std::string pathStr = path.string();
feat(lint): naming reads the AST, deleting the scope heuristic The rule was 125 lines: four std::regex, a hand-rolled {/} scope stack, a cumulative paren-depth counter so a wrapped parameter list would not look like a declaration, a 40-entry keyword denylist, and a "function-shaped line" guess whose own comment conceded it was heuristic. Storage class came from lineStr.contains("static "). It is now ~55 lines that ask clang what kind of declaration each thing is and what encloses it. The three regressions the old version carried special cases for — a call with an inline lambda argument, a bare statement call, a one-liner method — need no handling at all, because a call is not a declaration. Their tests pass unchanged. On this repository the exact version found 42 violations the heuristic had never been able to see, all real: - 37 members of the libclang function-pointer table added two commits ago were PascalCase. The old varDecl regex could not match a declaration whose type is decltype(&f), so they were silently skipped. Renamed to camelCase, which mirrors clang_createIndex -> createIndex more closely anyway. - Crafter.Build-Shader.cpp had a snake_case local, file_name_list, invisible to the heuristic for the same reason (it declares a const char* array). - Four extern "C" declarations of libc functions in tests were reported as badly-named functions. Those are named by the C library, so C language linkage is now an exemption — the same principled test no-char-pointer uses, rather than another denylist entry. New tests cover what the line-based version structurally could not reach: a signature wrapped over several lines, `static` on its own line above the declaration it applies to, and a member versus a local inside a method. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-30 23:53:26 +02:00
const char* fileNameList[1] = { pathStr.c_str() };
2026-07-23 01:24:42 +02:00
const char* shaderSource = src.data();
const std::int32_t shaderSourceLen = static_cast<std::int32_t>(src.size());
2026-04-27 07:04:42 +02:00
glslang::TShader shader(glslangType);
feat(lint): naming reads the AST, deleting the scope heuristic The rule was 125 lines: four std::regex, a hand-rolled {/} scope stack, a cumulative paren-depth counter so a wrapped parameter list would not look like a declaration, a 40-entry keyword denylist, and a "function-shaped line" guess whose own comment conceded it was heuristic. Storage class came from lineStr.contains("static "). It is now ~55 lines that ask clang what kind of declaration each thing is and what encloses it. The three regressions the old version carried special cases for — a call with an inline lambda argument, a bare statement call, a one-liner method — need no handling at all, because a call is not a declaration. Their tests pass unchanged. On this repository the exact version found 42 violations the heuristic had never been able to see, all real: - 37 members of the libclang function-pointer table added two commits ago were PascalCase. The old varDecl regex could not match a declaration whose type is decltype(&f), so they were silently skipped. Renamed to camelCase, which mirrors clang_createIndex -> createIndex more closely anyway. - Crafter.Build-Shader.cpp had a snake_case local, file_name_list, invisible to the heuristic for the same reason (it declares a const char* array). - Four extern "C" declarations of libc functions in tests were reported as badly-named functions. Those are named by the C library, so C language linkage is now an exemption — the same principled test no-char-pointer uses, rather than another denylist entry. New tests cover what the line-based version structurally could not reach: a signature wrapped over several lines, `static` on its own line above the declaration it applies to, and a member versus a local inside a method. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-30 23:53:26 +02:00
shader.setStringsWithLengthsAndNames(&shaderSource, &shaderSourceLen, fileNameList, 1);
2025-10-31 16:50:47 +01:00
shader.setEntryPoint(entrypoint.c_str());
shader.setSourceEntryPoint(entrypoint.c_str());
shader.setEnvTarget(glslang::EShTargetSpv, glslang::EShTargetSpv_1_4);
DirStackFileIncluder includeDir;
includeDir.pushExternalLocalDirectory(path.parent_path().generic_string());
2026-05-02 21:08:51 +02:00
for (const fs::path& dir : includeDirs) {
includeDir.pushExternalLocalDirectory(dir.generic_string());
}
2026-04-27 07:04:42 +02:00
2026-05-01 19:02:14 +02:00
if (!shader.parse(GetDefaultResources(), 100, false, messages, includeDir)) {
return fail("GLSL parse failed", std::string(shader.getInfoLog()) + shader.getInfoDebugLog());
2025-10-31 16:50:47 +01:00
}
2026-04-27 07:04:42 +02:00
2026-05-01 19:02:14 +02:00
glslang::TProgram program;
program.addShader(&shader);
if (!program.link(messages)) {
return fail("GLSL link failed", std::string(program.getInfoLog()) + program.getInfoDebugLog());
2025-10-31 16:50:47 +01:00
}
2026-04-27 07:04:42 +02:00
glslang::TIntermediate* intermediate = program.getIntermediate(glslangType);
2026-05-01 19:02:14 +02:00
if (!intermediate) {
// Defensive: parse+link succeeded above, so this should be
// unreachable. If glslang ever changes that contract we'd
// rather surface a clear error than dereference null (the
// pre-fix bug that masqueraded as a silent SIGSEGV).
return fail("glslang produced no intermediate code", {});
2025-10-31 16:50:47 +01:00
}
2026-04-27 07:04:42 +02:00
2025-10-31 16:50:47 +01:00
spv::SpvBuildLogger logger;
std::vector<std::uint32_t> spirv;
glslang::GlslangToSpv(*intermediate, spirv, &logger);
2026-05-01 19:02:14 +02:00
std::string spvLog = logger.getAllMessages();
2025-10-31 16:50:47 +01:00
fs::path filename = path.filename().replace_extension("spv");
std::ofstream file(outputDir/filename, std::ios::binary);
2026-05-01 19:02:14 +02:00
if (!file) {
return fail("failed to open SPIR-V output", (outputDir/filename).string());
}
2025-10-31 16:50:47 +01:00
file.write(reinterpret_cast<const char*>(spirv.data()), spirv.size() * sizeof(std::uint32_t));
2026-05-01 19:02:14 +02:00
if (!spvLog.empty()) {
return fail("SPIR-V codegen reported issues", std::move(spvLog));
}
glslang::FinalizeProcess();
return {};
2025-10-31 16:50:47 +01:00
}
}