https://github.com/chimehq/coresymbolication
Headers and package for CoreSymbolication
https://github.com/chimehq/coresymbolication
crash-reporting macos swift symbolication
Last synced: 3 months ago
JSON representation
Headers and package for CoreSymbolication
- Host: GitHub
- URL: https://github.com/chimehq/coresymbolication
- Owner: ChimeHQ
- License: bsd-3-clause
- Created: 2021-06-10T00:16:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T14:38:13.000Z (about 1 year ago)
- Last Synced: 2025-05-27T13:56:03.183Z (4 months ago)
- Topics: crash-reporting, macos, swift, symbolication
- Language: Swift
- Homepage:
- Size: 901 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![Build Status][build status badge]][build status]
[![Platforms][platforms badge]][platforms]
[![Matrix][matrix badge]][matrix]
# CoreSymbolication
CoreSymbolication provides a very powerful system for looking up and extracting symbolic information from mach-o executables, dyld shared caches, and dSYMs.
There are two parts. The private C API itself is wrapped up in the `CoreSymbolication` target, and a Swift wrapper is provided with `SwiftCoreSymbolication`.
The private header is definitely not complete. But, if there's something you need/want, open up an issue and we can look into it together.
One quick note. I cannot figure out how to craft a modulemap that will allow SPM to handle linking. This means that you need to add some special linker flags to any executable target that uses this as a dependency.
```swift
linkerSettings: [
.unsafeFlags([
"-Xlinker", "-F",
"-Xlinker", "/System/Library/PrivateFrameworks",
"-Xlinker", "-framework",
"-Xlinker", "CoreSymbolication",
]),
```
If you are here, you might also be interested in gSYM, an efficient format used by the LLVM project for symbolication. I also put together a [go library](https://github.com/ChimeHQ/gogsym) that can be used to consume gsym files.
## Integration
### Swift Package Manager
```swift
dependencies: [
.package(url: "https://github.com/ChimeHQ/CoreSymbolication")
],
targets: [
.target(
name: "UseCFunctionality",
dependencies: ["CoreSymbolication"]
),
.target(
name: "UseSwiftWrapper",
dependencies: [.product(name: "SwiftCoreSymbolication", package: "CoreSymbolication")]
),
]
```
## Contributing and Collaboration
I would love to hear from you! Issues or pull requests work great. A [Matrix space][matrix] is also available for live help, but I have a strong bias towards answering in the form of documentation.
I prefer collaboration, and would love to find ways to work together if you have a similar project.
I prefer indentation with tabs for improved accessibility. But, I'd rather you use the system you want and make a PR than hesitate because of whitespace.
By participating in this project you agree to abide by the [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
[build status]: https://github.com/ChimeHQ/CoreSymbolication/actions
[build status badge]: https://github.com/ChimeHQ/CoreSymbolication/workflows/CI/badge.svg
[platforms]: https://swiftpackageindex.com/ChimeHQ/CoreSymbolication
[platforms badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FChimeHQ%2FCoreSymbolication%2Fbadge%3Ftype%3Dplatforms
[matrix]: https://matrix.to/#/%23chimehq%3Amatrix.org
[matrix badge]: https://img.shields.io/matrix/chimehq%3Amatrix.org?label=Matrix