WIP: feat(vk): RX_VK_SPV_PROFILE, what the big SPIR-V modules are made of #695
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/upscaling
beanstalk: approved @ 1697603
beanstalk: approved @ 2c5a62e
beanstalk: approved @ 4fd82b7
beanstalk: approved @ 64d6d09
beanstalk: approved @ 6f91fae
beanstalk: approved @ 70a78f9
beanstalk: approved @ 8015c9a
beanstalk: approved @ 8d361dc
beanstalk: approved @ 9d8356e
beanstalk: approved @ abf2227
beanstalk: approved @ d82f202
beanstalk: approved @ e5f1e40
beanstalk: approved @ ee8ab5f
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
testing wanted
ci: approved
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!695
Loading…
Reference in a new issue
No description provided.
Delete branch "mooki/Longshot:mac/spv-size"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Type: feat · Risk: low · Tested on: macOS 26.7.1, Apple M4 Max (MoltenVK 1.4.2), game-free at this head · Needs: Windows, Linux, macOS profiled game run
Why
On a Mac, Metal's compiler spends minutes on a few of the game's compute programs (100,000-560,000 SPIR-V words), and nothing in
the log says what makes them that big. SPIRV-Cross, MoltenVK's translator to Metal, makes every function but the entry point
always_inline, so Metal compiles one function, the entry point with every call written out: a helper of W words called C timescosts about C × W there, and the SPIR-V's own size says little. This PR adds a log-only diagnostic, off by default:
RX_VK_SPV_PROFILE=1prints, for each big module a run translates, what its written-out entry point is made of and what eachApple-only translation feature adds, so a profiled run names the cost instead of guessing it. It is part of the macOS port. See
#420.
What changed
RX_VK_SPV_PROFILE=1makes each of the translator's 7 stage emissions measure a module overRX_VK_SPV_PROFILE_MINSPIR-Vwords (100000): the module is emitted as always, then the same IR again with every feature as it was and once without each
Apple-only feature that is on; one
vk: spv profile N/200: …line per such module (at most 200 a run) is printed where theprogram is kept. The module itself is never touched; unset, every stage is emitted by the one
EmitSPIRVcall it had, nothing iswalked or printed, and neither switch is in the program cache's stamp (neither changes a word of SPIR-V).
gpu/vk/spirv_profile.h(new: no Vulkan, no environment):count(a module's words, functions, calls, instructionsby kind, and its entry point with every call written out, by where the words come from: the entry point, the
null_*,seg_*andtexel_*helpers, the rest),emit_measured(the emissions with and without each ofnnul,rord,msld,txcdand
seg, kept by the module's words until its line prints) and the line (under 1000 characters at its widest).gpu/vk/vk_shader.cpp:spv_profile_on(),spv_profile_min(),spv_profiled::EmitSPIRV(every stage'semission), and the line at the three places a translated program is kept (
translate_into,translate_mesh_into,seed_compute's kept variants), with the program's kind, key, variant and stage.docs/development.md, rows forRX_VK_SPV_PROFILEandRX_VK_SPV_PROFILE_MIN.tests/test_spv_profile.py(new) withtests/spv_profile_ir.cpp(new):seg_shader_ir.cpp's synthetic programsthrough the real back end with this Mac's profile; every module's counts against an independent walk in Python, every
feature's measured words against fresh emissions with and without it, the off path byte for byte, the line's shape, width and
cap, and the sources (7 emissions through the wrapper, the switches read with
env_on/env_int, neither in the stamp's list).Measurements
Verdict: works as designed game-free: unset, every module is byte for byte the plain emission and nothing is measured; set,
each feature's measured words equal what fresh emissions with and without it differ by (24 program and feature pairs), every
count equals the independent walk (31 modules), and the line keeps under 1000 characters. Cost when set: a big module is emitted
up to 6 more times (back end only), so a profiled run translates slower; not measured on the game (no profiled run yet).
Hardware: macOS 26.7.1, Apple M4 Max, 64 GB, Apple clang 21 (game-free)
Scene: none (the back end's synthetic programs, emitted with and without each feature and walked)
Method:
tests/test_spv_profile.pyat this head, arm64 and--arch x86_64(Rosetta), and with--treeagit archiveof thisPR's base, which must fail;
tests/test_seg_shader.py --base-treethe same archive, arm64 and x86_64. Exact checks: one run perroute.
How to reproduce:
python -I -B tests/test_spv_profile.py --headers <SPIRV-Headers/include> [--arch x86_64] [--tree <git archive of the base>]Baseline: the "before" column is this PR's base, #676 (
1c21f295), whose Apple-only features (#674'snnul, #675'srord,#676's
msld, #649'stxcd, the segmented binding) this diagnostic measures (main has none of them).1c21f295d0a38783EmitSPIRVper stage)storageprogram, set: written-out words and their sourcesinlined 9491 = entry 556 + null 46 (1 calls) + seg 8403 (41 calls) + texel 0 (0 calls) + other 486 (24 calls); addsnnul 1998/1961,seg 6516/5997test_spv_profile(this PR's test)--treethe base): "gpu/vk/spirv_profile.h: missing"test_seg_shader --base-tree), arm64 and x86_64Flags and settings
Two new switches, off by default, log-only. The diff against main also shows the switches of the PRs it stacks on, theirs to
list:
HOS_KEEP_FREED_PAGES,HOS_ZERO_ALL_PAGES,RX_NVN_WATCH_AFTER,RX_NVN_WATCH_ALL,RX_NVN_WATCH_TEXELS_SRC(#480),RX_VK_LIBRARY(#438),RX_VK_DLSS_ACTORS,RX_VK_GPU_DUMP,RX_VK_MESH_IND_COUNT_WORD,RX_VK_NO_UPSCALE_STUB(#658),RX_VK_TEXEL_CODECS(#649),RX_VK_SET_FOR_TABLES(#643) andRX_VK_SET_FOR_LENGTHS(#644).RX_VK_SPV_PROFILE=1vk: spv profileline per big module translated in the run (at most 200)RX_VK_SPV_PROFILE_MIN=<words>Testing
Tested: on macOS 26.7.1, Apple M4 Max, at this head (main
6c9edffe, #676's stack, this PR), game-free, every run under theshared check slot with a fresh HOME and TMPDIR:
tests/test_spv_profile.py, arm64 and x86_64: exit 0, as in Measurements; with--treethe base: fails as required.tests/test_seg_shader.py --base-treethe base, arm64 and x86_64: exit 0, 139 of 139 identical (the switch unset changes nomodule).
test_amd_subgroup_profiles,test_program_stamp_knobs(19 switches; this PR's two are not translation switches),test_program_cache_format: exit 0.vk_shader.cpp(which includes the newspirv_profile.h) compiled whole with main 6c9edffe's renderer flags forarm64 and x86_64: 2 of 2, exit 0 (scratch tree with #476, #492 and #490).
objects, 1,216 name/arch checks, closure 565 symbols a route, 0 undefined.
are the topic's line for line in all 5 files; the end commit changes text only.
reports/PubWave-files/PubShader2/(proof/spv-d0a38783-*.log) andreports/PubWave-files/PubShader3/(
compile/spv-spv-size-d0a38783/,equal-lines.txt,stamps.txt,offapple-spv-1c21f295-d0a38783.txt,merge-tree.txt,wave/).Not tested: a profiled game run (the switch set in a start; no line from the game's own modules yet). Windows and Linux: not
built there (
vk_shader.cppdiffers from the base's off Apple and includes the new header everywhere); its test request coversit.
Must be tested:
RX_VK_SPV_PROFILE=1(the runner's environment allowlistneeds both switches), expecting one
vk: spv profile N/200: …line per module over 100000 words, joinable by key and variantwith the slow compile lines, at most 200 and the cap's line once (by hand: the owner, the log's
vk:lines)d0a38783, it carries #676 with the PRs it stacks on) and main6c9edffethe sameway and start each to the title, and run
python -I -B tests/run_all.pyon Linux, expecting the build to compilevk_shader.cppwith the new header, the shaders prepared once more (a new translator stamp), no
spv profileline with the switch unset, andevery other line to match main's (by hand: test request T-XXXX)
Risks
What could break: unset, nothing runs but one flag check per emission (the off path's words are checked byte for byte). Set,
a fault in the re-emission would throw at translation of a big module (the program fails loudly) or print wrong numbers (each is
checked against fresh emissions and an independent walk); the extra emissions slow a profiled run's translation.
Turning it off: leave
RX_VK_SPV_PROFILEunset (the default).Compatibility: every platform's shaders are prepared again once (
vk_shader.cppis in the translator's stamp:02ba705207103076→63ae14e6c3cafe38), to the same SPIR-V; no translator stamp word.kProgramCacheFormatstays 3. Nothingchanges in saves,
longshot_options.inior the vk ABI (MKWVK_API_VERSION).Reviewer notes
1c21f295..d0a38783, three commits:e37b9aacand045909c5,-xfrommacos/spv-size(a8a72532,1a50b01b),their changed lines the topic's line for line in all 5 files (
macos/integrated6e7ce601); one conflict, indocs/development.md's switch table, where the topic's base had the precompile hand-off's rows (#652): only this PR's two rowsare added. Then end commit
d0a38783(text only): the switch row and three comments named "the slow compiles above", arow and a line main has not; they now say the program's kind, key, variant and stage, as the precompile hand-off's slow compile
line has them (true with #652 and without it).
1c21f295) for the features it measures (nnul,rord,msld,txcd,seg) andtests/seg_shader_ir.cpp's programs. #696 merges this branch (its fixture counts written-out words withspirv_profile.h).because what it measures is #676's stack.
tests/test_amd_subgroup_profiles.py, #676's lines: keep both drivers' lines, asmacos/integrated); #681, #652 (and #666, #667):docs/development.mdswitch rows, keep both.git merge-treewith#692, #694, #693, #677-#680, #686: clean. The other conflicts with #650/#652 are the base's.
reports/2026-11-14-*.md(the port's design notes), which are not in this repository.Issues
See #420
Checklist
Everyone
type(scope): description) of the status line's type.main(maine090cc48).python -I -B tests/run_all.pypasses (any failure that also fails onmainis named). (On the wave's merge77333ce0: #693 on #692, #697 with #696, #694 and this PR, #698 with #654, and one fixture commit for the cut-outmake_profilestubs: 565 passed, 31 failed, 18 skipped against main 6c9edffe's 531/32/17 on this Mac; the 31 failures are main's own and nothing that passes on main fails;test_collect_widenow passes; 33 new tests pass,test_spv_profileamong them;test_darwin_audio_service, Darwin-only, is skipped by the runner;reports/PubWave-files/PubShader3/wave/full-77333ce0/.)third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.tests/that reads changed source updated in this PR, not weakened.Every scan down vk_memory.cpp's import table by start (pool_lookup's covering import and merge plan, bg_drain, prefetch_chunks, import_in_background, memory_note_gpu_write and memory_guest_imported) stopped once an import ended more than 1 GiB below its address, on the belief that no import is larger than that. pool_lookup's own merge escape leaves an import above 1 GiB over the smaller ones inside it ("left overlapping"), and the device allows imports up to max_import_size: a scan stopped at a small import inside a large one, missed the large one, and the same bytes were imported again, two memories over the same bytes. import_reach.h counts the live imports by span class; its bound is above every live span, within twice the largest. imported_add and imported_take, now the table's only ways in and out, keep the count. A scan stops only where no import further down can reach its address, so it also stops sooner than before when the imports are small. The covering-import checks in pool_lookup and import_in_background look past the last import at or below the range for the same reason. Tests: test_import_reach.py runs the actual scans with a 4 GiB import over a 16 MiB chunk, left by the merge escape (imports are recorded ranges: no payload, no Vulkan, no game). Its lookup, query, note, drain, background and prefetch cases fail on main5e072fc8and pass here, and a source check keeps every change to the table in the two helpers. test_import_windows runs pool_lookup with the helpers; test_mirror_gpu_only names the new publication point. Assisted-by: Claude Opus 5.5 Co-Authored-By: Claude Opus 5.5 <[email protected]>044635ea added vma_startup_rollback (vk_vma.cpp, run after a failed replay_start), which calls vmaDestroyAllocator. vk_vma.cpp includes vk_work.h last so that RX_VK_RECORDER=defer/thread drains before its destructions, and every such boundary call in a vk_work.h file must be in RX_REC_BOUNDARIES with a drain-first macro. This one was not, and test_recorder_sync caught it ("vk_vma.cpp calls ['vmaDestroyAllocator'], which vk_work.h does not drain before"): it passes at 58c5c5aa (044635ea's parent) and fails at 044635ea. Add it to the list and to vk_work.h, next to vmaDestroyBuffer and vmaDestroyImage. With the recorder off (the default) boundary() is a relaxed load and a branch. Rollback runs before any image or buffer exists, so nothing should be held there today, but the allocator is no longer destroyed while a recorder could still hold packets. The test is unchanged (sources: 42 boundaries drained, was 41). Assisted-by: Claude Opus 5.5 Co-Authored-By: Claude Opus 5.5 <[email protected]>A guest span larger than one device allocation (the cap on MoltenVK/M4 Max is 41,747,087,360 bytes) is bound as pieces: one descriptor per allocation segment, at the descriptor's own binding (reports/2026-11-14-full-range-design.md sections 4.1-4.4). This is the shader half; the draw side (descriptors, layout, gathers) comes later. - runtime_info.h: SegEntry {Storage|Table|TexBuf|ImgBuf, desc, pieces} and RuntimeInfo::segmented. - Back end: a segmented storage buffer is an array of pieces at its binding (a table count * pieces, entry k's piece j at k * pieces + j); its loads, stores and atomics call DontInline helpers made after main, which find the piece by the pieces' OpArrayLength in order, with constant indices. The global memory fallbacks sum the pieces' lengths for a segmented descriptor's bound end and branch to its piece (single, native candidate, table written out and in the loop). Texel and image buffers are arrays too, their fetches, reads, writes and atomics through helpers that pick the piece by OpImageQuerySize, and a texel buffer's size query sums the pieces. ImageQuery was declared for every module already. With RuntimeInfo::segmented empty nothing new is made: the SPIR-V is byte-identical. - vk_shader: SegSig (entries, hash) on Program, seg_sig and seg_variant; program_segmented finds or translates the variant of a plain program with plain's texture questions and answers and checks its descriptors are plain's; program_pick, mesh_program_locked, program_find_plain, loaded_variants and portable_variant keep the plain and segmented variants apart; every stage's RuntimeInfo::segmented comes from Program::seg. - vk_progcache: a segmented variant is never written to the program cache nor listed among the loaded programs. - tests/test_seg_shader.py + tests/seg_shader_ir.cpp: synthetic IR programs through the real back end, plain and segmented; structure checks, spirv-val (Vulkan 1.3, uniform buffer standard layout), and with --base-tree a byte comparison of the plain modules against an older tree. Five source-reading checks follow the new Program field and the atomics' new branch. The translator stamp changes with this (eden/, vk_shader.cpp, sizeof(Program)): every program cache is rebuilt once. Land it in the same release as the vk_api.h change that already does so. Assisted-by: Claude Opus 5.5 Co-Authored-By: Claude Opus 5.5 <[email protected]> (cherry picked from commit b7928876dab846485f667c1c934d34d25ecef035)The interfaces the four segmented-consumer lanes (SegBind, SegXfer, TexelDesc, NullShader; reports/2026-11-14-seg-consumer-plan.md section 3) code against, frozen before they fork. Inert: no caller of anything new, no SPIR-V, layout, push range or stream change, sizeof(Program) unchanged. - vk_internal.h / vk_memory.cpp, SegMem's consumer interface: gpu_span_any() (a relaxed count of the live domains, stored in seg_commit; domains are kept for the run), gpu_span (gpu_buffer's flavour of gpu_span_bind: import buffers, no written marks, no mirror), SpanLayout::bind_stamp (gpu_bind_stamp(): a segment can be imported again with its cuts kept, so cut_gen alone never keys piece buffers), span_unused_piece's semantics ({null_storage, 0, 1}), and the SegArena API (SegArenaRef, seg_arena_take, seg_gather, seg_scatter; stub bodies after stream_alloc that give no room and log, SegBind's to fill). - Review fixes in the same interface (renderer-core review P2-3, P3.2): every piece of gpu_span_bind carries its buffer's device address (the import's or the mirror's; 0 only with bufferDeviceAddress off), and its one-piece path stores the translated guest address, not a virtual one. - vk_texture.h/.cpp: texel_view_pieces / texel_piece_views, stubs that return 1 and false (TexelDesc's to fill). - vk_shader.h: Program::presence_words, in what was padding. - Back end: PRESENCE_PUSH_OFFSET (88), Profile::emulate_null_descriptors, Bindings::presence / presence_read with the bit numbering rule. - tests: test_resolver_coverage lists gpu_span_bind / gpu_span sites too (scoped to gpu/vk: gpu/render has an rx::gpu_span of its own), checks that gpu_span follows its own gpu_buffer, and splits SITES into SITES_BASE plus one block per lane. test_segmented_domains executes the contract (the count 0, 1, 2 -> 1 on a merge, 0; gpu_span's pieces; addresses with the fixture's gpu_buffer_bind returning none as the real one does; the bind stamp; a virtual address's guest). test_seg_shader accepts a base tree of this back end's generation and compares every module. - docs/segmented-binding.md: the gate (every new behaviour Apple-only, other platforms byte-identical) and one heading per lane. Conflict on this branch (not with main): tests/test_seg_shader.py's docstring, against the array_pointer_calls paragraph #P20's msl-arrayptr port added; both kept, this paragraph first. Assisted-by: Claude Opus 5.5 Co-Authored-By: Claude Opus 5.5 <[email protected]> (cherry picked from commit 95fa06d4e6526601bd2e1bc88c2f8f5720855350)The segmented single storage array's case (plan 4.3 item 5) had no negative: the check always cut its own tree. With --source <B2 archive> it fails as required ("moltenvk.segmented_single want=set got=push"). Conflict with #P28 (read_write textures; not with main): the docstring keeps #P28's paragraph with this usage line, and main() cuts from --source's vk_draw.cpp with #P28's read_write count (as in the macOS integration, Integration 17). Assisted-by: Claude Opus 5.5 Co-Authored-By: Claude Opus 5.5 <[email protected]> (cherry picked from commit 5824f6828e21cf810dcceaa6be425a9224b15994)plaine37c097da2plaina997b3629aDefineImages and DefineImageBuffers declare one image whatever the descriptor's count, while Image() indexes the variable when the count is above 1, so such a module fails spirv-val ("OpAccessChain reached non-composite type"); B2 has it already, on every platform. The null_img* and null_imgbuf* helpers take their element the same way and share it. Found while extending the fixture; declaring the arrays changes every platform's SPIR-V and is left to the owner. Assisted-by: Claude Opus 5.5 Co-Authored-By: Claude Opus 5.5 <[email protected]> (cherry picked from commit 83e7e18b4fee477f1e6901871ad37efe8f23d5bf)SPIRV-Cross (MoltenVK 1.4.2's pin 6c09849f) prints an OpImageRead's result, and a pure read helper's call, where the value is first used, and nothing orders it against the same invocation's later writes and atomics on that image: in MSL the read ran after them and returned the later value. TexOrder's TO-01 probe proved it on the GPU for LS's plain output, with and without the NullShader bit, on both CPU routes (reports/2026-11-14-tex-order.md). - Profile::materialize_image_reads, set by make_profile on Apple for MoltenVK only, with its translator stamp word ("rord") only when on. - emit_spirv_image.cpp InPlace: with the flag, every storage image and image buffer read's result (the plain read, the segmented read helper's call, a carrier codec's element reads) is stored to a Private variable at the read and loaded back; SPIRV-Cross prints a store where it stands. Private, since a Function variable must lead its function's first block; in the entry point's interface from SPIR-V 1.4. Off: no new ID, every module byte for byte as before. - tests/seg_shader_ir.cpp: order-* modules with the flag; the read-in-place rule (every read and read helper call stored at once), their flag-off twins breaking it, CPU runs equal to the modules without the flag, and the flag alone changing nothing without image reads. test_seg_shader.py: order- modules required; a base tree without the flag builds them with TEX_ORDER_BASE and they are not compared; --source against it fails. - tests/spirv_run.h runs Private variables (fresh per invocation) and OpMemoryBarrier (a no-op one invocation at a time). - docs/segmented-binding.md: a TexOrder section. Conflicts on mac/null-shader (#P33), with MslArrayPtr's tests that #P33's last commit carries, not with main; resolved as macos/integrated did (Integration 22, b08694d8): tests/seg_shader_ir.cpp keeps both sections and both calls (msl_arrayptr, then tex_read_order); tests/spirv_run.h keeps both storage classes (Uniform, then Private); tests/test_seg_shader.py keeps both docstring paragraphs and presence checks, leaves 'msl-' and 'order-' out of an older generation's set, and compares with a base in one loop (an order- module skipped for a base without the flag, identical counts as the same, a different segmented one listed under --changed-segmented, anything else fails). Assisted-by: Claude Opus 5.5 Co-Authored-By: Claude Opus 5.5 <[email protected]> (cherry picked from commit a9aad5bcd6f4cce3d9fcff8b231da9628e7da4b3)d0a38783bc0b7b97fb760b7b97fb7643d1a23420Folded into #848 (feat(vk): the SPIR-V back end on MoltenVK and guest spans past one device allocation)
Pull request closed