WIP: feat(macos): count NVN's polygon modes and restart-off strip draws on Apple, log-only #677
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 @ 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!677
Loading…
Reference in a new issue
No description provided.
Delete branch "mooki/Longshot:mac/mode-census"
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), arm64 and x86_64 under Rosetta · Needs: macOS, Apple silicon (a start on the rebased stack); Windows and Linux, any GPU (build and start)
Why
Two things the game might ask for are missing on a Mac. KosmicKrisp has no
fillModeNonSolid, and MoltenVK cannot drawPOINT polygons, so a pipeline in NVN's LINE or POINT polygon mode would be drawn wrong there. And Metal restarts an indexed strip
or fan at the all-ones index (0xFF, 0xFFFF, 0xFFFFFFFF) whatever Vulkan's restart enable says, so a strip drawn with restart off
whose indices hold that value would be cut where Windows and Linux draw it whole. Before anything is fixed, this PR counts
whether the game does either, on Apple only, without changing what is built or drawn. It is part of the macOS port. See #420.
What changed
A census on Apple builds: the graphics pipelines built and the draws recorded by NVN's polygon mode, and the indexed strip and
fan draws with restart off, with a direct draw's indices read on the CPU for the all-ones value. Printed with the frame
statistics every 120 presents and at close. Nothing built or drawn changes, and off Apple every call compiles to nothing.
gpu/vk/mode_census.h(new).kOnisdefined(__APPLE__).Censuskeeps the pipeline counts (global atomics), eachrecording thread's own draw counts (
join, written only by that thread) and the first 8 LINE and POINT pipelines, programsand all-ones draws by name.
restart_off_stripis the gate (indexed, not a mesh draw, NVN's restart off, a strip or fan:topologies 2, 4, 5, 7, 9);
scan_indicesreads a direct draw'scountindices from its index address through the caller'sreader in 4096-byte pieces, uncapped, and stops at the first all-ones value. An indirect draw (its range is the GPU's) and a
range the CPU cannot read are counted as not scanned, never guessed.
gpu/vk/vk_draw.cpp:census_pipelinewherebuild_graphicscountsst_pipelines,census_drawon each of thefive
st_draws++lines,census_restartjust before an indexed direct or indirect draw is recorded (reading throughmemory_read_as_submitted), anddraw_mode_census_report; astatic_assertholds the strip and fan topologies to Vulkan'senum.
gpu/vk/vk_draw.hdeclares the report;gpu/vk/vk_replay.cpplog_frame_statsprints it after the skips line(
at present N);gpu/vk/vk_main.cppmkwvk_close_askedprints it afterdraw_layouts_report(at close).tests/test_mode_census.py+tests/mode_census_test.cpp(new) run the real header on authored draws: the modes, thegate over every topology, 8/16/32-bit scans, a large scan, unreadable and indirect ranges, the report lines, and that no file in
the shader stamp names the census.
tests/test_fallback_pipeline_state.pyandtests/seg_gathers_test.cpp(#663's), whichcompile
build_graphicsanddraw()'s binds from the source, get a stand-in for the counts;tests/test_seg_gathers.py's endmarker is
draw()'s last line without what follows it.Measurements
Verdict: the counts answered both questions, and neither needs a fix: in every game start that carried this commit on the
integration branch, the game built and drew FILL only (LINE 0, POINT 0, pipelines and draws), and its restart-off strips (up to
154 by the close) all held no all-ones index. The cost is a few nanoseconds a draw on Apple.
Baseline: main does not start on macOS. The game numbers come from integration builds that carry this commit unchanged
(
09f9a171for runs #21/#22,e7730869for #24/#25,6962f8fbfor #26), arm64, MoltenVK 1.4.2, the field-dawn save; the costfrom the lane's bench of the real header and helpers.
Hardware: macOS 26.7.1, Apple M4 Max (40-core GPU), MoltenVK 1.4.2, 16-core CPU, 64 GB
Scene: runs #21/#22: the title, the menu and the field-dawn save's load (the device was lost in the load); #24: to play (one
gameplay shot); #25/#26: 900 s held in play
Method: every
vk: polygon modes (andvk: primitive restart off (line of each run's log (reports/2026-11-14-mac-startup-21.mdappendix,
-22.mdappendix,-24.md,-25.md,-26.md); the per-draw cost:reports/ModeCensus-files/tools/bench.cpp, best of 5,arm64 (receipt 11)
How to reproduce: start the game on a Mac with this PR's stack and read those lines;
reports/2026-11-14-mode-census.mdexplainseach count
6c9edffe(no census; main does not start on macOS)Flags and settings
None: no switch. The census is on in Apple builds and compiled out elsewhere.
Testing
Tested: on macOS 26.7.1, Apple M4 Max, at this head (main
6c9edffeplus #663 and what it carries):tests/test_mode_census.pywith--arch arm64and--arch x86_64(the fixture under Rosetta): pass, 10 cases each; with thetest copied onto #663's head it fails (no
gpu/vk/mode_census.h) (reports/PubWave-files/PubLate2/proof-01/mc-census-*,proof-02a/mc-base-census-*).tests/test_seg_gathers.py(--arch arm64,--arch x86_64) andtests/test_fallback_pipeline_state.py(/usr/bin/clang++and
clang++ -arch x86_64): pass (proof-01/mc-*).gpu/vk/vk_draw.cpp,gpu/vk/vk_main.cppandgpu/vk/vk_replay.cppcompiled whole for arm64 and x86_64 with main's rendererflags (#476's, #492's and #490's macOS compile pieces merged in a scratch tree only): 6 objects, exit 0, no warnings
(
reports/PubWave-files/PubLate2/compile/mode-census/).unifdef -U__APPLE__, base against head): the four renderer files differ andmode_census.his included, butevery census call returns at once on
kOn(false) and the report prints nothing(
reports/PubWave-files/PubLate2/offapple-mode-census.txt).tools/ls-suite.pyat #678's head (this PR plus one commit and a docs row): 208 pass, 16 fail: 13 fail on main
6c9edffeon this Mac too, andtest_precompile_compute_guard,test_shader_module_guardandtest_present_aspect_vulkan, which main's full suite skips hereand which fail the same way at #663's head when named (
reports/PubWave-files/PubLate2/related-mvk-temp-01/,-compare.txt,related-base-b8579f1a-01/).1bd30dceon the integration branch: 561 passed, 1 failed (test_menu_i18n, failingon its base too), 16 skipped; mutations of the scan (capped) and of the gate (fans dropped) fail the test
(
reports/2026-11-14-mode-census.md).Not tested: a game start on this PR's stack (main with #663 does not start on macOS by itself; the counts above are from the
integration branch, where this commit is byte-identical); KosmicKrisp in the game (the counts are NVN's state, the same on any
driver); not built on Windows or Linux; its test request covers it.
Must be tested:
vk: polygon modes (at present N; …)andvk: primitive restart off (at present N)every 120 presents and once moreat close(by hand: the parent's game run).e1153ec7, it carries #663, #662, #658, #649, #648, #647, #645, #644, #643 and#491) and main
6c9edffethe same way and start each to the title, expecting novk: polygon modesorvk: primitive restart offline, and every other line to match main's (by hand: test request T-XXXX).Risks
What could break: on Apple builds only, replay time: a restart-off strip or fan has its indices read on the CPU at every
draw, uncapped (2^20 16-bit indices in about 0.3-0.5 ms); the runs above had at most 154 such draws by the close. Every other
draw pays the gate's compares and one count on its thread's own counters. The
vk: skips a frame by vk_draw.cpp line:numbersafter line 66 move.
Turning it off: revert the PR (no switch: the census is log-only).
Compatibility: Nothing changes for players: no file in the shader stamp changed, so nothing is translated again; no
MKWVK_API_VERSIONchange.Reviewer notes
b8579f1a..e1153ec7(1 commit):cherry-pick -xofmacos/mode-census1bd30dce, with one conflict ingpu/vk/vk_draw.h: the declaration goes in abovedraw_layouts_report's comment, kept as #663 has it (the source commit sat on#646's longer wording of that comment). The pick's changed lines equal the source commit's (sorted,
pick-mode-census-lines.txt).tests/seg_gathers_test.cppandtests/test_seg_gathers.py, which the stand-in and end marker edit, andthe
census_restartcall sits next to SegBind's index bind), and through it #662, #658, #649, #648, #647, #645, #644, #643 and#491.
git merge-treeof this head (reports/PubWave-files/PubLate2/merge-check-mode-census.txt):gpu/vk/vk_draw.hwith #646(the declaration next to #646's comment: keep both);
gpu/vk/vk_draw.cppwith #681 (its block and include next tothis PR's: keep both); every other conflict is #663's own (with #490, #454, #646's test, #650, #652 and its stack,
#669). #678 and #679 (with #680) stack on this PR.
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 merge937a502a= drawid-direct9c2bd272(carries count-drawsc45636d2and this PRe1153ec7) + mvk-temp3e34116c(also on this PR) + metal-scratch4edae82c: 562 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; 30 new tests pass;test_darwin_audio_service, Darwin-only, is skipped by the runner;reports/PubWave-files/waveC2r/full-937a502a/.)third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.mainand passing here.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)plaine37c097da2plaina997b3629aKosmicKrisp has no fillModeNonSolid and MoltenVK no POINT polygons, and Metal restarts an indexed strip or fan at the all-ones index whatever Vulkan's restart enable says. Before anything is fixed, count whether the game needs it (mode_census.h, Apple only; nothing built or drawn changes): - the graphics pipelines built, where st_pipelines counts them, and the draws recorded, where st_draws counts them, by NVN's polygon mode, with the first 8 LINE and POINT pipelines (program, pipeline key, topology) and programs named; - the indexed strip and fan draws with restart off; a direct one's indices are read whole, a page at a time, through memory_read_as_submitted for the index type's all-ones value (0xFF, 0xFFFF, 0xFFFFFFFF). An indirect one's range is the GPU's and a range the CPU cannot read is not guessed: both are counted as not scanned. Any other draw costs restart_off_strip's compares and its polygon mode's count on the thread's own counters. Printed with the frame statistics every 120 presents ("at present N") and at close ("at close"). The two tests that compile build_graphics and draw()'s binds from the source get a stand-in for the counts. Assisted-by: Claude Opus 5.5 Co-Authored-By: Claude Opus 5.5 <[email protected]> (cherry picked from commit 1bd30dceb348909ca03c4cf12709dccbb0900f4a)e1153ec7e5648232f043648232f043d2fd7a90ffFolded into #850 (fix(macos): draw-path emulation on MoltenVK)
Pull request closed