西风逍遥游
31880f0021
`examples/<name>/` was a tested surface in name only. The source-quality job had no examples check at all, and scripts/smoke_examples.sh accepted any process that had not printed one of its error markers: a project that died during startup, exited after a single frame, or crashed without a marker was reported as PASS. Nothing stopped a malformed or unregistered example from reaching dev, which is how 14 examples arrived without READMEs and 20 were never registered in the overview table. Source side - scripts/check_examples.py classifies every directory under examples/ as either runnable (main.nut plus a config.nut that assigns the engine `config` table) or as a reviewed non-runnable sample listed in NON_RUNNABLE_EXAMPLES with a reason. Both kinds must own a README.md and appear in examples/README.md. Stale exemptions and overview links to missing directories fail as well. - `make check/examples` and a new source-quality CI step run the gate. - scripts/tests/test_check_examples.py covers it and pins each failure mode against fixtures. Runtime side - scripts/smoke_examples.sh now enforces liveness, not just marker absence: every runnable example must still be running after MIN_RUN_SECONDS (default 2s; CI passes 2s), and a process that dies inside that window fails whatever its exit code. A clean self-exit after the window passes with an explicit note instead of being silently accepted as a pass. - The Linux CI step sets MIN_RUN_SECONDS=2 and keeps RUN_SECONDS=6, so the job's wall clock is unchanged (13.7 min of its 20 min budget on dev). Windows / GBK - scripts/utf8_stdio.py re-encodes stdout/stderr as UTF-8 and every scripts/*.py program calls it as the first statement of its __main__ block. On a Chinese Windows a redirected stream falls back to the ANSI code page (cp936), and printing a character that code page cannot encode (arrows, superscripts, bullet separators, emoji - all common in this repository) raised UnicodeEncodeError and turned a checker into a traceback. - The mirror image is input: read_text() without encoding= decoded UTF-8 repository text as cp936 and raised UnicodeDecodeError. - scripts/tests/test_utf8_stdio.py enforces both conventions for every script and test module; text file I/O and child-process decoding now pass encoding="utf-8" explicitly. - Unit-test invocations run with `python3 -X utf8` so the runner's own output never follows the host code page. Violations the new gates found on top of dev, fixed here: 14 examples shipped without a README (fluid3d, mesh-impact-lab, mesh-modifier-lab, spline-tube-lab on the earlier dev tip, plus pcg-depth-of-field, pcg-detail-overwrite, pcg-layer-culling, pcg-location-system, pcg-runtime-orchestration, pcg-scene-player-culling, pcg-snow-wind, pcg-thunder-strike, pcg-ui-scaler and pcg-underwater added by #397), 20 were missing from the overview table (those 14 plus archspace-editor, geometry-stroke-lab, interior-mapping, layered-animation, triplanar-decal, terrain-stamping), and scripts/export_meshret_onnx.py had no UTF-8 stdio guard. Verified locally: `python -m ruff check scripts` (All checks passed); scripts/check_test_manifest.py; scripts/check_quality_metadata.py; scripts/check_architecture_contracts.py --base HEAD; scripts/check_nodiscard.py; `make -n check/examples`; scripts/check_examples.py (125 examples: 118 runnable, 7 reviewed non-runnable); and `python -X utf8 -m unittest discover -s scripts/tests -p "test_*.py"` (155 tests, OK). The runtime half of the contract needs a Linux headless build, so it is verified by the CI examples smoke step rather than locally.
86 lines
2.7 KiB
Python
86 lines
2.7 KiB
Python
#!/usr/bin/env python3
|
|
"""Compile the stage-2 GPU-driven compute shaders (HZB build / cull / emit).
|
|
|
|
Writes the same artifacts as scripts/compile_mesh3d_shaders.py:
|
|
- <name>.comp.spv (tracked binary)
|
|
- <name>_comp_spv.inc (embedded C++ array, consumed by Graphics.cpp)
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import struct
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
import utf8_stdio
|
|
|
|
ROOT = Path(__file__).resolve().parents[1]
|
|
SHADER_DIR = ROOT / "src" / "modules" / "graphics" / "shaders"
|
|
|
|
SHADERS = [
|
|
("hzb_build.comp", "comp"),
|
|
("gpu_cull.comp", "comp"),
|
|
("gpu_emit.comp", "comp"),
|
|
("vg_main_cull.comp", "comp"),
|
|
]
|
|
|
|
|
|
def spv_to_inc(spv_path: Path, array_name: str, out_path: Path) -> None:
|
|
data = spv_path.read_bytes()
|
|
if len(data) % 4 != 0:
|
|
raise SystemExit(f"SPIR-V size not multiple of 4: {spv_path}")
|
|
words = struct.unpack(f"<{len(data) // 4}I", data)
|
|
if not words or words[0] != 0x07230203:
|
|
raise SystemExit(f"bad SPIR-V magic in {spv_path}")
|
|
lines = [f"static const uint32_t {array_name}[] = {{"]
|
|
row: list[str] = []
|
|
for i, w in enumerate(words):
|
|
row.append(f"0x{w:08x}")
|
|
if len(row) == 8:
|
|
lines.append(" " + ", ".join(row) + ",")
|
|
row = []
|
|
if row:
|
|
lines.append(" " + ", ".join(row) + ",")
|
|
lines.append("};")
|
|
lines.append(
|
|
f"static const size_t {array_name}_count = sizeof({array_name})/sizeof({array_name}[0]);"
|
|
)
|
|
lines.append("")
|
|
out_path.write_text("\n".join(lines), encoding="utf-8")
|
|
print(f"wrote {out_path.name} ({len(words)} words)")
|
|
|
|
|
|
def compile_one(src: Path) -> Path:
|
|
out = Path(str(src) + ".spv")
|
|
glslc = shutil.which("glslc")
|
|
glslang = shutil.which("glslangValidator")
|
|
if glslc:
|
|
cmd = [glslc, "-fshader-stage=comp", f"-I{SHADER_DIR}", str(src), "-o", str(out),
|
|
"--target-env=vulkan1.2"]
|
|
elif glslang:
|
|
cmd = [glslang, "-V", "-S", "comp", f"-I{SHADER_DIR}", "--target-env", "vulkan1.2",
|
|
str(src), "-o", str(out)]
|
|
else:
|
|
raise SystemExit("need glslc or glslangValidator on PATH (Vulkan SDK)")
|
|
r = subprocess.run(cmd, capture_output=True, text=True)
|
|
if r.returncode != 0:
|
|
raise SystemExit(f"compile failed for {src.name}:\n{r.stderr or r.stdout or '(no output)'}")
|
|
return out
|
|
|
|
|
|
def main() -> int:
|
|
for name, stage in SHADERS:
|
|
src = SHADER_DIR / name
|
|
if not src.is_file():
|
|
raise SystemExit(f"missing {src}")
|
|
spv = compile_one(src)
|
|
array = f"{src.stem}_{stage}_spv"
|
|
spv_to_inc(spv, array, SHADER_DIR / f"{src.stem}_{stage}_spv.inc")
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
utf8_stdio.enable_utf8_stdio()
|
|
import shutil
|
|
sys.exit(main())
|