https://github.com/chimehq/gogsym

Go library for reading GSYM files
https://github.com/chimehq/gogsym

dsym go llvm symbolication

Last synced: 4 days ago
JSON representation

Go library for reading GSYM files

• Host: GitHub
• URL: https://github.com/chimehq/gogsym
• Owner: ChimeHQ
• License: bsd-3-clause
• Created: 2021-06-12T00:11:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-25T17:20:58.000Z (over 1 year ago)
• Last Synced: 2024-11-16T17:17:32.772Z (about 1 month ago)
• Topics: dsym, go, llvm, symbolication
• Language: Go
• Homepage:
• Size: 38.1 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Github CI](https://github.com/ChimeHQ/gogsym/workflows/CI/badge.svg)](https://github.com/ChimeHQ/gogsym/actions)

# gogsym

Go library for reading GSYM files.

GSYM is a binary file format useful for performing symbolication. It is much smaller and more efficient than using a dSYM.

A format definition can be derived from the LLVM [headers](https://github.com/llvm/llvm-project/tree/main/llvm/include/llvm/DebugInfo/GSYM) and [sources](https://github.com/llvm/llvm-project/tree/main/llvm/lib/DebugInfo/GSYM).

## usage

```go

f, _ := os.Open("my.gsym")

g, _ := NewGsymWithReader(f)

lr, _ := g.LookupTextRelativeAddress(0x3291)

```

# llvm-gsymutil

`llvm-gsymutil` can create and read gsym files. You can build it from the LLVM sources. It takes a long time to build.

    cmake -DLLVM_ENABLE_PROJECTS="llvm-gsymutil" llvm

    make llvm-gsymutil

    bin/llvm-gsymutil -h

## Suggestions or Feedback

We'd love to hear from you! Get in touch via an issue or pull request.

Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.