Repository navigation
Enable Kirshara queue protections on macOS #339
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Guffawaffle
wants to merge
1
commit into
STFC-Mod:dev
Choose a base branch
from
Guffawaffle:fix/macos-kirshara-parity
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Kirshara protections on macOS | ||
|
|
||
| Faster Queue Recovery and Thin Queue Protection use their existing implementation | ||
| on Apple Silicon and Intel. Queue Address Guard already supports macOS. The | ||
| shared `[control] kirshara_fixes` option controls the protections on every platform; | ||
| this change adds no settings and changes no queue policy or defaults. | ||
|
|
||
| ## Qualification | ||
|
|
||
| Historical Mac client 199 (`1.000.52486`) inspection found the same 24-byte course | ||
| response layout: fleet at 0, success at 8, recall at 9, target at 16. Its aggregate | ||
| argument is indirect on Apple Silicon and stack-passed on Intel, matching the host | ||
| C++ ABI. The seven detour targets exceeded the architecture-specific SPUD overwrite | ||
| windows in those binaries. That historical evidence does not establish native | ||
| hook fit for a newer client. Runtime metadata checks reject incompatible managed | ||
| layouts; they do not validate native method extent. | ||
|
|
||
| Current Mac build, native-fit and exact-artifact runtime results must be recorded | ||
| separately for each tested architecture and game version. | ||
|
|
||
| ## Focused smoke test | ||
|
|
||
| 1. Set `[control] queue_enabled = true` and `kirshara_fixes = true`. Leave | ||
| `[patches] actionqueuerecoveryhooks`, `thinqueueprotectionhooks` and | ||
| `queueaddressguardhooks` enabled; restart after changing hook switches. | ||
| 2. Confirm startup logs report `[FasterQueueRecovery] ready=true`, | ||
| `[ThinQueueProtection] ready=true` and `[QueueAddressGuard] ready=true`. | ||
| Preserve any unavailable or hook-install failure messages. | ||
| 3. Queue same-system hostiles on ship A. Move or recall ship B from another | ||
| system; A's queue should survive and continue normally. | ||
| 4. Recall A itself, then separately clear its queue manually. Both should clear. | ||
| 5. Let another player remove A's queued head before engagement. Check progression | ||
| to the next eligible target, then repeat with respawns and two ships. Watch for | ||
| duplicate engagements, stalled courses, unexpected clearing or crashes. | ||
| 6. Compare `kirshara_fixes` off/on. Without the settings UI, edit the existing TOML | ||
| key and restart. Record commit, artifact hash, architecture, game version, | ||
| exact steps and logs. Disable an affected hook switch and restart if needed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,8 +2,8 @@ | |
| #include <config.h> | ||
|
|
||
| // Port of the active v2.1.0-guffa.10 guard, not the dormant completion repair. | ||
| // Windows x64 callback ABI is validated against running metadata; current native fit is recorded separately. | ||
| #if defined(_WIN32) && defined(_M_X64) | ||
| // Shared 64-bit managed layout; incompatible runtime contracts leave the feature unavailable. | ||
| #if (defined(_WIN32) && defined(_M_X64)) || (defined(__APPLE__) && (defined(__arm64__) || defined(__x86_64__))) | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same for this? |
||
| #include <algorithm> | ||
| #include <atomic> | ||
| #include <array> | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems redundant considering this is the platforms we cover?