Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chronostasys/immix
Immix GC for LLVM based languages
https://github.com/chronostasys/immix
gc immix llvm stackmap
Last synced: 4 months ago
JSON representation
Immix GC for LLVM based languages
- Host: GitHub
- URL: https://github.com/chronostasys/immix
- Owner: Chronostasys
- License: mit
- Created: 2024-05-27T03:46:39.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-09-27T10:20:56.000Z (4 months ago)
- Last Synced: 2024-09-30T03:40:30.790Z (4 months ago)
- Topics: gc, immix, llvm, stackmap
- Language: Rust
- Homepage:
- Size: 429 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Immix GC for LLVM-based Languages
Welcome to the Immix GC project! This project aims to provide a highly efficient and easily integrable [immix garbage collector (GC)][2] for all languages that use LLVM as their backend. Originally a part of the [Pivot Lang project](https://github.com/Pivot-Studio/pivot-lang), this GC leverages LLVM's [stackmap][1] functionality to assist in stack scanning and supports both conservative and precise garbage collection.
[1]: https://llvm.org/docs/StackMaps.html
[2]: https://www.steveblackburn.org/pubs/papers/immix-pldi-2008.pdf
## Features
- **High Performance**: Designed for high efficiency to minimize the overhead of garbage collection.
- **Easy Integration**: Simple to integrate with any LLVM-based language.
- **Support for Conservative and Precise Collection**: Flexible enough to work with both conservative and precise memory management paradigms.
- **LLVM Stackmap Integration**: Utilizes LLVM's stackmap feature for effective stack scanning.
- **LLVM Passes and GC Strategy Plugins**: Comes with built-in LLVM passes and corresponding GC strategy plugins to facilitate integration.
- **Evacuation**: Supports object evacuation to reduce fragmentation and improve memory locality.
## Supported Platforms
- Linux amd64
- windows amd64
- macOS aaarch64
The above 3 platforms are tested and supported, other platforms may work but are not officially supported.
Theoretically this GC should work on all amd64 and aarch64 platforms.
## Build
To build the Immix GC, you will need to have the following dependencies installed:
- LLVM 18.x
- CMake 3.10 or higher
- Rust 1.55 or higher
Once you have the dependencies installed, you can build the Immix GC by following these steps:
1. Clone the repository:
2. Build project with Cargo:
```bash
cargo build
```
don't forget to add the `--release` flag if you want to build the release version.
## Usage
### Using Immix GC on C Programs
We have some built-in LLVM passes and GC strategy plugins that you can use to integrate the Immix GC with existing C programs.
[example.c](example.c) is a simple C program that playing with a binary tree, it's originally using the system malloc/free to manage memory. You can compile it with `clang example.c` and run it with `./a.out`.
To use the Immix GC, you can recomplie the program running
```bash
./compile_example.sh
```
Then you can run the program with `./a.out`. The program will run with the Immix GC, and produce exactly the same result as before.
### Using on your own LLVM-based language
TODO
## Language using Immix GC
- [Pivot Lang](https://github.com/Pivot-Studio/pivot-lang)
## Contributing
We welcome contributions from the community! Here are some ways you can contribute:
- Submit bug reports and feature requests.
- Write documentation and tutorials.
- Improve the performance and capabilities of the GC.
- Integrate Immix GC with more languages and provide examples.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Acknowledgements
This project is inspired by the need for a performant garbage collection system in the [Pivot Lang project](https://github.com/Pivot-Studio/pivot-lang) and has evolved to become a stand-alone solution for all LLVM-based languages. Special thanks to all contributors and the LLVM community for their support.
---
Happy Coding!