"""Smoke test for build/xlate/nx2navi_xlate(.exe): no game files needed. Sends one hand-assembled Maxwell fragment shader (writes the constant colour 1.0, 0.5, 0.25, 1.0 to render target 0) through --serve, checks the reply, then sends a malformed line and checks the service survives and still answers. Two hand-assembled compute shaders follow. One loads a texel from a float image and stores it back: the translator declares such an image without a format, and its read needs StorageImageReadWithoutFormat. The other reads only the layer count of texture handle 0x10, for which the translator has no type answer: the texture must be declared as an array, or the count reads as 1. Every module is validated with spirv-val. Last, pool_check sends a fragment shader that queries a texture whose handle it reads from an input, which the translator reads from the texture pool array: the array must have tools/xlate/Program.cs TexturePoolLength entries and the handle must be clamped to the last of them. A translator older than its sources (0.10.0 and 0.10.1 shipped one whose pool had 32768 entries) fails it. tools/make_launcher.py check_xlate runs pool_check on the translator it ships. python tools/xlate_smoke.py [--exe ] """ import json import os import re import shutil import struct import subprocess import sys import tempfile from pathlib import Path ROOT = Path(__file__).resolve().parent.parent EXE = ROOT / "build" / "xlate" / ("nx2navi_xlate.exe" if os.name == "nt" else "nx2navi_xlate") SPIRV_VAL = (Path(r"C:\msys64\ucrt64\bin\spirv-val.exe") if os.name == "nt" else Path(shutil.which("spirv-val") or "/usr/bin/spirv-val")) PT = 7 << 16 # predicate "always" def mov32i(dest: int, value: float) -> int: imm = struct.unpack(" bytes: header = [0] * 20 header[0] = 2 | (3 << 5) | (5 << 10) # SPH type 2, version 3, stage fragment header[18] = 0xF # OMAP: render target 0, components xyzw words = [SCHED, mov32i(0, 1.0), mov32i(1, 0.5), mov32i(2, 0.25), SCHED, mov32i(3, 1.0), EXIT, 0] return struct.pack("<20I", *header) + struct.pack(f"<{len(words)}Q", *words) SULD_P, SUST_P = 0x1D61, 0x1D65 # opcode bits 51-63 of SULD.P and SUST.P TXQ = 0x1BE9 # opcode bits 51-63 of TXQ (bound handle) def surface_p(opcode: int, data: int, coord: int, handle: int) -> int: """SULD.P / SUST.P 1D RGBA: the data registers from `data` on, coordinate register, image handle (TidB).""" no_pred_out = 7 << 30 if opcode == SULD_P else 0 # SULD's second destination predicate: PT, none written return (opcode << 51) | (handle << 36) | no_pred_out | (0xF << 20) | PT | (coord << 8) | data def image_read_code() -> bytes: """Compute code: R0-R3 = image 0 at x 0 (SULD.P), stored back there (SUST.P).""" words = [SCHED, surface_p(SULD_P, 0, RZ, IMAGE0), surface_p(SUST_P, 0, RZ, IMAGE0), EXIT] return struct.pack(f"<{len(words)}Q", *words) def layer_count_code() -> bytes: """Compute code: R0 = the layer count (component 2 of the dimension query) of texture handle 0x10, stored to image 0.""" txq = (TXQ << 51) | (0x10 << 36) | (0x4 << 31) | (1 << 22) | PT | (RZ << 8) | 0 # TexHeaderDimension, mask z, LOD RZ sust = (SUST_P << 51) | (IMAGE0 << 36) | (0x1 << 20) | PT | (RZ << 8) | 0 # SUST.P 1D R of R0 at x 0 words = [SCHED, txq, sust, EXIT] return struct.pack(f"<{len(words)}Q", *words) IPA = 0xE0 << 56 # IPA, pass mode TXQ_B = 0x1BEA # opcode bits 51-63 of TXQ.B (handle in a register) def pool_query_code() -> bytes: """Fragment code: R4 = user attribute 0.x (IPA of a[0x80]), R0 = the width of the texture whose handle is R4 (TXQ.B of the dimension, mask x), R1-R3 constants; render target 0 = R0-R3.""" header = [0] * 20 header[0] = 2 | (3 << 5) | (5 << 10) # SPH type 2, version 3, stage fragment header[18] = 0xF # OMAP: render target 0, components xyzw ipa = IPA | (7 << 47) | (RZ << 39) | (0x80 << 28) | (RZ << 20) | PT | (RZ << 8) | 4 txq = (TXQ_B << 51) | (0x1 << 31) | (1 << 22) | PT | (4 << 8) | 0 words = [SCHED, ipa, txq, mov32i(1, 0.0), SCHED, mov32i(2, 0.0), mov32i(3, 1.0), EXIT, 0] return struct.pack("<20I", *header) + struct.pack(f"<{len(words)}Q", *words) def spirv_clamps(spv: bytes): """The lengths of a module's OpTypeArray types and the 32-bit constants its GLSL.std.450 UMin instructions take.""" w = struct.unpack(f"<{len(spv) // 4}I", spv[:len(spv) // 4 * 4]) consts, lengths, umin, glsl = {}, [], [], None i = 5 # after the header while i < len(w): n, op = w[i] >> 16, w[i] & 0xFFFF if not n: break ins = w[i:i + n] if op == 11 and struct.pack(f"<{n - 2}I", *ins[2:]).split(b"\0")[0] == b"GLSL.std.450": # OpExtInstImport glsl = ins[1] elif op == 43 and n == 4: # OpConstant: type, id, value consts[ins[2]] = ins[3] elif op == 28: # OpTypeArray: id, element type, length lengths.append(ins[3]) elif op == 12 and n > 5 and ins[3] == glsl and ins[4] == 38: # OpExtInst UMin umin += ins[5:] i += n return [consts.get(x) for x in lengths], [consts[x] for x in umin if x in consts] def pool_check(exe: Path): """None when exe declares the texture pool array with tools/xlate/Program.cs TexturePoolLength entries and clamps a pool handle to the last of them; otherwise why not.""" m = re.search(r"TexturePoolLength = (\d+)", (ROOT / "tools" / "xlate" / "Program.cs").read_text(encoding="utf-8")) if not m: return "tools/xlate/Program.cs names no TexturePoolLength" length = int(m.group(1)) with tempfile.TemporaryDirectory() as tmp: tmp = Path(tmp) code = tmp / "pool_ps.bin" code.write_bytes(pool_query_code()) out = tmp / "out" job = {"key": "pool_ps", "stage": "ps", "code": str(code), "debug": False, "fout": {"0": "float"}} try: r = subprocess.run([str(exe), "--serve"], input=json.dumps({"job": job, "out": str(out)}) + "\n", capture_output=True, text=True, timeout=60) except (OSError, subprocess.SubprocessError) as e: return f"the translator does not run: {e}" if r.stdout.strip() != "ok pool_ps": return f"the translator answered {r.stdout.strip()[:120]!r} to the texture pool shader" try: textures = json.loads((out / "pool_ps.res.json").read_text(encoding="utf-8")).get("textures") or [] lengths, clamps = spirv_clamps((out / "pool_ps.spv").read_bytes()) except (OSError, ValueError, struct.error) as e: return f"the translator's texture pool shader cannot be read: {e}" pools = [t.get("array") for t in textures if t.get("pool") == 1] if pools != [length] or length not in lengths: return (f"the translator declares the texture pool with {pools or 'no'} entries, where its sources say {length} " f"(tools/xlate/Program.cs TexturePoolLength): it is older than its sources") if length - 1 not in clamps: return f"the translator clamps a texture pool handle to {clamps}, not to {length - 1}" return None def main() -> int: exe = Path(sys.argv[sys.argv.index("--exe") + 1]) if "--exe" in sys.argv[1:-1] else EXE if not exe.is_file(): print(f"missing {exe}; run tools/build_xlate.py", file=sys.stderr) return 2 with tempfile.TemporaryDirectory() as tmp: tmp = Path(tmp) code = tmp / "ps.bin" code.write_bytes(fragment_code()) image_code = tmp / "cs.bin" image_code.write_bytes(image_read_code()) layer_code = tmp / "layers.bin" layer_code.write_bytes(layer_count_code()) out = tmp / "out" job = {"key": "const_ps", "stage": "ps", "code": str(code), "debug": False, "fout": {"0": "float"}} image_job = {"key": "image_read_cs", "stage": "cs", "code": str(image_code), "debug": False, "local": [1, 1, 1]} layer_job = {"key": "layer_count_cs", "stage": "cs", "code": str(layer_code), "debug": False, "local": [1, 1, 1]} lines = [ json.dumps({"job": job, "out": str(out)}), "this is not json", json.dumps({"job": dict(job, key="again"), "out": str(out)}), json.dumps({"job": image_job, "out": str(out)}), json.dumps({"job": layer_job, "out": str(out)}), ] r = subprocess.run([str(exe), "--serve"], input="\n".join(lines) + "\n", capture_output=True, text=True, timeout=60) replies = r.stdout.splitlines() print("replies:", replies) if (len(replies) != 5 or replies[0] != "ok const_ps" or not replies[1].startswith("fail ") or replies[2] != "ok again" or replies[3] != "ok image_read_cs" or replies[4] != "ok layer_count_cs"): print("unexpected replies; stderr:", r.stderr, file=sys.stderr) return 1 failed = 0 layer_types = [t["type"] for t in json.loads((out / "layer_count_cs.res.json").read_text())["textures"]] if layer_types != [0x103]: # SamplerType Texture2D (3) | Array (0x100) print(f"layer_count_cs: texture types {layer_types}, expected a 2D array [259]", file=sys.stderr) failed = 1 for key in ("const_ps", "image_read_cs", "layer_count_cs"): spv = out / f"{key}.spv" data = spv.read_bytes() if len(data) < 20 or struct.unpack("