-
Notifications
You must be signed in to change notification settings - Fork 17
release: 0.10.1 #77
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
Closed
Closed
release: 0.10.1 #77
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,40 @@ | ||||||
| # 0.10.1 | ||||||
|
|
||||||
| ## Highlights | ||||||
|
|
||||||
| Patch release on top of `0.10.0`. Ships a critical generic-context dispatch fix that was crashing `StructDescriptor` / `ClassDescriptor` / `EnumDescriptor` reads made through `any ContextDescriptorProtocol`, and aligns demangling call sites with the new async API in `swift-demangling` 0.3.0. | ||||||
|
|
||||||
| ## Bug Fixes | ||||||
|
|
||||||
| - **Generic context dispatch (signal-11 crash)**: the `ReadingContext` overload of `genericContext(in:)` introduced during the reading-context refactor was declared as a protocol extension only, with no override on `TypeContextDescriptorProtocol`. Calls through `any ContextDescriptorProtocol` therefore statically dispatched to the base implementation, which built a `TargetGenericContext<GenericContextDescriptorHeader>` (8-byte header) even when the descriptor was a `StructDescriptor` / `ClassDescriptor` / `EnumDescriptor`. Those descriptors actually start with `TypeGenericContextDescriptorHeader` (16 bytes — two relative offsets preceding the `base` header), so the read was misaligned by 8 bytes. The misaligned bytes usually surfaced as a garbage `valueHeader.numValues` of ~`UInt32.max`, after which `readWrapperElements` walked ~4 billion fabricated `GenericValueDescriptor` slots and crashed with `EXC_BAD_ACCESS`. | ||||||
| - Promoted `genericContext(in:)` and `parent(in:)` to protocol requirements on `ContextDescriptorProtocol` so they participate in witness-table dispatch. | ||||||
| - Added matching overrides on `TypeContextDescriptorProtocol` that route through `typeGenericContext(in:)?.asGenericContext()`, mirroring the `MachOSwiftSectionRepresentableWithCache` path. | ||||||
| - Mirrored the new overloads on `TypeContextDescriptorWrapper` / `ValueTypeDescriptorWrapper` for API parity. | ||||||
| - Resolves `EXC_BAD_ACCESS` in `MultiPayloadEnumTests` and in `GenericSpecializationTests.main` via `SwiftInterfaceIndexer.indexTypes`. | ||||||
|
|
||||||
| ## Dependencies | ||||||
|
|
||||||
| - **`swift-demangling` minimum bumped to `0.3.0`**. 0.3.0 makes `Node.print`, `demangleAsNode`, and `mangleAsString` async (with stack-safe execution) and adds the `DemanglingTestingSupport` module. Call sites in `SwiftDump`, `SwiftInterface`, and the test suites have been migrated to `await` the new entry points. Downstream consumers using these public demangling APIs will need to `await` them as well. | ||||||
|
|
||||||
| ## CI | ||||||
|
|
||||||
| - Added `GenericSpecializationTests`, `GenericSpecializerAPITests`, `MultiPayloadEnumTests`, and `MetadataReaderDemanglingTests` to the macOS matrix filter, so any future regression in the generic-context dispatch path surfaces in CI rather than as a local signal-11. | ||||||
| - `Sources/swift-section/Version.swift` is now the single source of truth for the CLI version: | ||||||
| - `release.yml` no longer injects the version via heredoc; it fails a tagged release when `BundledVersion.value != github.ref_name`. | ||||||
| - A new `version-check.yml` workflow runs on every push to `main` and every PR, and fails when `Changelogs/<BundledVersion.value>.md` does not exist. | ||||||
| - The extraction shell is whitespace-tolerant and guards `grep`'s exit status so formatter changes cannot silently break the check. | ||||||
| - As a result, source builds (including Homebrew's source path) report the correct version without depending on CI injection. | ||||||
|
|
||||||
| ## Docs | ||||||
|
|
||||||
| - Corrected MachOKit version in the `0.10.0` notes: `0.49.100` (based on upstream `0.49.0`), not `0.47.100`. | ||||||
| - `KNOWN_ISSUES.md` annotated recent CI runs that reproduced the `SymbolIndexStore.demangledNode` data race so its flaky, parallel-harness-only nature is easier to recognize during triage. | ||||||
|
|
||||||
| ## Requirements | ||||||
|
|
||||||
| - Swift 6.2+ | ||||||
| - Xcode 26.0+ (CI validates on Xcode 26.4 / macOS 26) | ||||||
|
|
||||||
| ## Known Issues | ||||||
|
|
||||||
| See [KNOWN_ISSUES.md](https://github.com/MxIris-Reverse-Engineering/MachOSwiftSection/blob/0.10.1/KNOWN_ISSUES.md) — same two non-blocking parallel-harness concurrency items as 0.10.0. | ||||||
|
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. Use a relative link for
Suggested change
|
||||||
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
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.
The version requirements for Swift, Xcode, and macOS appear to be typos. Swift 6.0, Xcode 16.0, and macOS 15 are the current major versions. Using "6.2", "26.0", and "26" seems incorrect and could mislead users about the project's compatibility.