WIP: fix(builder): a preparation the GPU driver stalled is not promised for the first start #1174

Draft
TrashPanda wants to merge 1 commit from TrashPanda/Longshot:fix/prepare-stall-message into main
Contributor

Type: fix · Risk: low · Tested on: Linux, RTX 4070 Ti (game-free checks) · Needs: none

Why

When the GPU driver stops answering during the build's shader preparation, the build said the game would prepare the shaders at its first start. It does not: the stopped run leaves a marker, every start skips the preparation while it is there, and each shader is built when it is first drawn. Players were told to expect something that does not happen.

Restored from Hookshot 2985, by jarynclouatre, and split out of #286 so it can be reviewed and merged on its own.

How to reproduce

Seen on: any PC whose driver stalls during the shader preparation (exit status 4 from prepare_watchdog)
Settings and switches: defaults
Steps: build the game until the preparation is stopped by the watchdog
Expected: a line that says what happens next
Actual: "the game prepares them at its first start"

What changed

nx2/make_game.py's not_prepared takes the line's ending, and exit 4 now says the game builds each shader when it first draws it and the next build or update tries the preparation again. Longshot's builders are command line only, so the builder windows' part of the Hookshot fix is left out.

Commits, each with its original author and message:

fac87a2e fix(builder): a preparation the GPU driver stalled is not promised for the first start (jarynclouatre)

When the GPU driver stops answering during the build's shader
preparation (prepare_watchdog, exit status 4), the builder printed
"the shaders were not prepared now (the GPU driver stopped responding):
the game prepares them at its first start". The game does not do that.
The stopped run leaves hookshot_prepare_skipped beside the game, and
every start skips the preparation while it is there, so each shader is
built when it is first drawn, until a later build's preparation runs
through and removes the file.

Change

  • nx2/make_game.py: not_prepared takes the ending as an argument,
    defaulting to the old one (FIRST_START). Exit 4 says "the game builds
    each shader when it first draws it, and the next build or update tries
    the preparation again". The other reasons keep their text, and the
    marker's behaviour stays as it is.
  • The three builders read the ending of the line instead of assuming it:
  • Windows builder (ShaderStep.Note): the row says "Left to the game's
    first start: why" as before, or "Not prepared: why. Then what happens".
  • Python builder (window.py) and Linux builder
    (hookshot_builder.py): the same, in each one's own wording.
  • tests/builder_workers/Program.cs follows the rename.

Testing

  • tests/test_prepare_at_build.py, new cases:
  • make_game: exit 4's line does not promise the first start and names
    first drawn. Exit 3, a silent run and another status keep "at its first
    start".
    • Both Python builders: the row text for each kind of line.
    • The new cases fail on main and pass here.
  • Full suite on Linux: 473 passed, 53 skipped, 2 failed, both the same
    on main on this machine (test_bake_portability: zstandard is not
    installed; nx2/test_texture_init_barrier.py: clang++ is not
    installed).
  • The C# builder and tests/builder_workers were not compiled: there is
    no .NET SDK on this machine.
  • No game ran.

Ported to Longshot: make_game.py's line and its check only. Longshot's builders are command line only (#171, #181), so
the builder windows' rows and their checks are left out.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2985

Measurements

Verdict: nothing to measure: a correctness fix off the frame path, covered by game-free checks.

Flags and settings

None.

Testing

Tested: On Linux (kernel 7.0), RTX 4070 Ti, main @ 71b1edd8, this PR @ fac87a2e: tests/test_prepare_at_build.py pass. The full suite (tests/run_all.py) has not been run on this branch yet; a comment will follow when it has.

Not tested: A build whose preparation the driver really stalls. Opened as work in progress until it runs in the game.

Must be tested:

  • None: the line is the only change, and the check covers each exit status

Risks

What could break: the builder's line after a stalled preparation.

Turning it off: revert the commit.

Compatibility: Nothing changes.

Checklist

Everyone

  • One topic.
  • The title is a Conventional Commit (type(scope): description) of the status line's type.
  • Why gives the reason plainly and links the issues that fit (the tracker searched).
  • Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what
    can't be run by hand is in Testing's Not testable by hand, with why.
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and
    in Risks.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main.
  • No game files, dumps, build output or generated files.
  • third_party/ untouched (a new folder with a PROVENANCE.md instead).
  • The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named).

When it applies

  • A game-free test added for the fix, failing on main and passing here.
**Type:** fix · **Risk:** low · **Tested on:** Linux, RTX 4070 Ti (game-free checks) · **Needs:** none ## Why When the GPU driver stops answering during the build's shader preparation, the build said the game would prepare the shaders at its first start. It does not: the stopped run leaves a marker, every start skips the preparation while it is there, and each shader is built when it is first drawn. Players were told to expect something that does not happen. Restored from [Hookshot 2985](https://github.com/NotRexed/Hookshot/pull/2985), by jarynclouatre, and split out of [#286](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/286) so it can be reviewed and merged on its own. ## How to reproduce **Seen on:** any PC whose driver stalls during the shader preparation (exit status 4 from `prepare_watchdog`) **Settings and switches:** defaults **Steps:** build the game until the preparation is stopped by the watchdog **Expected:** a line that says what happens next **Actual:** "the game prepares them at its first start" ## What changed `nx2/make_game.py`'s `not_prepared` takes the line's ending, and exit 4 now says the game builds each shader when it first draws it and the next build or update tries the preparation again. Longshot's builders are command line only, so the builder windows' part of the Hookshot fix is left out. Commits, each with its original author and message: <details><summary><code>fac87a2e</code> fix(builder): a preparation the GPU driver stalled is not promised for the first start (jarynclouatre)</summary> When the GPU driver stops answering during the build's shader preparation (`prepare_watchdog`, exit status 4), the builder printed "the shaders were not prepared now (the GPU driver stopped responding): the game prepares them at its first start". The game does not do that. The stopped run leaves `hookshot_prepare_skipped` beside the game, and every start skips the preparation while it is there, so each shader is built when it is first drawn, until a later build's preparation runs through and removes the file. #### Change - `nx2/make_game.py`: `not_prepared` takes the ending as an argument, defaulting to the old one (`FIRST_START`). Exit 4 says "the game builds each shader when it first draws it, and the next build or update tries the preparation again". The other reasons keep their text, and the marker's behaviour stays as it is. - The three builders read the ending of the line instead of assuming it: - Windows builder (`ShaderStep.Note`): the row says "Left to the game's first start: why" as before, or "Not prepared: why. Then what happens". - Python builder (`window.py`) and Linux builder (`hookshot_builder.py`): the same, in each one's own wording. - `tests/builder_workers/Program.cs` follows the rename. #### Testing - `tests/test_prepare_at_build.py`, new cases: - make_game: exit 4's line does not promise the first start and names first drawn. Exit 3, a silent run and another status keep "at its first start". - Both Python builders: the row text for each kind of line. - The new cases fail on main and pass here. - Full suite on Linux: 473 passed, 53 skipped, 2 failed, both the same on main on this machine (`test_bake_portability`: `zstandard` is not installed; `nx2/test_texture_init_barrier.py`: `clang++` is not installed). - The C# builder and `tests/builder_workers` were not compiled: there is no .NET SDK on this machine. - No game ran. Ported to Longshot: make_game.py's line and its check only. Longshot's builders are command line only (#171, #181), so the builder windows' rows and their checks are left out. Restored-from: https://github.com/NotRexed/Hookshot/pull/2985 </details> ## Measurements **Verdict:** nothing to measure: a correctness fix off the frame path, covered by game-free checks. ### Flags and settings None. ## Testing **Tested:** On Linux (kernel 7.0), RTX 4070 Ti, `main` @ 71b1edd8, this PR @ fac87a2e: `tests/test_prepare_at_build.py` pass. The full suite (`tests/run_all.py`) has not been run on this branch yet; a comment will follow when it has. **Not tested:** A build whose preparation the driver really stalls. Opened as work in progress until it runs in the game. **Must be tested:** - None: the line is the only change, and the check covers each exit status ## Risks **What could break:** the builder's line after a stalled preparation. **Turning it off:** revert the commit. **Compatibility:** Nothing changes. ## Checklist ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what can't be run by hand is in Testing's Not testable by hand, with why. - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and in Risks. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. - [ ] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). ### When it applies - [x] A game-free test added for the fix, failing on `main` and passing here.
fix(builder): a preparation the GPU driver stalled is not promised for the first start
Some checks are pending
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 8s
fac87a2edf
When the GPU driver stops answering during the build's shader
preparation (`prepare_watchdog`, exit status 4), the builder printed
"the shaders were not prepared now (the GPU driver stopped responding):
the game prepares them at its first start". The game does not do that.
The stopped run leaves `hookshot_prepare_skipped` beside the game, and
every start skips the preparation while it is there, so each shader is
built when it is first drawn, until a later build's preparation runs
through and removes the file.

## Change

- `nx2/make_game.py`: `not_prepared` takes the ending as an argument,
defaulting to the old one (`FIRST_START`). Exit 4 says "the game builds
each shader when it first draws it, and the next build or update tries
the preparation again". The other reasons keep their text, and the
marker's behaviour stays as it is.
- The three builders read the ending of the line instead of assuming it:
- Windows builder (`ShaderStep.Note`): the row says "Left to the game's
first start: why" as before, or "Not prepared: why. Then what happens".
- Python builder (`window.py`) and Linux builder
(`hookshot_builder.py`): the same, in each one's own wording.
- `tests/builder_workers/Program.cs` follows the rename.

## Testing

- `tests/test_prepare_at_build.py`, new cases:
- make_game: exit 4's line does not promise the first start and names
first drawn. Exit 3, a silent run and another status keep "at its first
start".
  - Both Python builders: the row text for each kind of line.
  - The new cases fail on main and pass here.
- Full suite on Linux: 473 passed, 53 skipped, 2 failed, both the same
on main on this machine (`test_bake_portability`: `zstandard` is not
installed; `nx2/test_texture_init_barrier.py`: `clang++` is not
installed).
- The C# builder and `tests/builder_workers` were not compiled: there is
no .NET SDK on this machine.
- No game ran.

Ported to Longshot: make_game.py's line and its check only. Longshot's builders are command line only (#171, #181), so
the builder windows' rows and their checks are left out.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2985
Author
Contributor

Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti 12 GB, NVIDIA 595.99.02, Ryzen 7 9800X3D: this branch built together with the other 18 split from #218 and #284-#288, merged onto main @ 71b1edd8 (make_game.py --update, build v3.0.0-rc.5-82-g5952bb3d), then played by a scripted tour through the control bridge (scripts/memtour.py: a save loaded, Zora's Domain, the Market, Hyrule Field and Death Mountain Trail, 40 s each with walking and camera swings). All 4 stops reached, a clean quit, and no device loss or Vulkan error in the log. The build's shader preparation ran to the end without a stall, so the changed message did not show.

Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti 12 GB, NVIDIA 595.99.02, Ryzen 7 9800X3D: this branch built together with the other 18 split from #218 and #284-#288, merged onto main @ 71b1edd8 (make_game.py --update, build v3.0.0-rc.5-82-g5952bb3d), then played by a scripted tour through the control bridge (scripts/memtour.py: a save loaded, Zora's Domain, the Market, Hyrule Field and Death Mountain Trail, 40 s each with walking and camera swings). All 4 stops reached, a clean quit, and no device loss or Vulkan error in the log. The build's shader preparation ran to the end without a stall, so the changed message did not show.
Owner

Brought up to the ready-for-review standard (#1454): the checklist's Everyone list has two new boxes, added here from what this PR's description and comments show (please check they match what you know).

  • Tested on my own PC: ticked: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, though the changed stall message did not show.
  • Nothing gets worse that I know of: ticked: Measurements gives a verdict of nothing to measure for a correctness fix, and Risks names no slower, latency or memory cost.
Brought up to the [ready-for-review standard](https://git.magicbean.dev/MagicBeanDev/Longshot/src/branch/main/CONTRIBUTING.md#ready-for-review-out-of-wip) (#1454): the checklist's Everyone list has two new boxes, added here from what this PR's description and comments show (please check they match what you know). - *Tested on my own PC*: ticked: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, though the changed stall message did not show. - *Nothing gets worse that I know of*: ticked: Measurements gives a verdict of nothing to measure for a correctness fix, and Risks names no slower, latency or memory cost.
Some checks are pending
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 8s
This pull request is marked as a work in progress.
Some workflows are waiting to be reviewed.
This branch is out-of-date with the base branch
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'fix/prepare-stall-message:TrashPanda-fix/prepare-stall-message'
git switch 'TrashPanda-fix/prepare-stall-message'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
MagicBeanDev/Longshot!1174
No description provided.