https://github.com/silverlightning926/garbage-collector-cpp
A Simulated Garbage Collector Written In C++.
https://github.com/silverlightning926/garbage-collector-cpp
cpp garbage-collection garbage-collector
Last synced: 3 months ago
JSON representation
A Simulated Garbage Collector Written In C++.
- Host: GitHub
- URL: https://github.com/silverlightning926/garbage-collector-cpp
- Owner: silverlightning926
- License: mit
- Created: 2024-07-21T12:05:59.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-23T20:27:04.000Z (10 months ago)
- Last Synced: 2024-12-30T09:19:44.296Z (5 months ago)
- Topics: cpp, garbage-collection, garbage-collector
- Language: C++
- Homepage:
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Garbage Collector in C++
---
 
---
 
---
- [Garbage Collector in C++](#garbage-collector-in-c)
- [Introduction](#introduction)
- [Current Status](#current-status)
- [Getting Started](#getting-started)
- [Tools](#tools)
- [Clang-Tidy](#clang-tidy)
- [Clang-Format](#clang-format)
- [Valgrind](#valgrind)
- [Logic](#logic)
- [Upcoming Features](#upcoming-features)
- [License](#license)
## Introduction
Garbage collection is a form of automatic memory management used by a program or programming language. The garbage collector, or just collector, attempts to reclaim garbage, or memory occupied by objects that are no longer in use by the program.
Therefore, to understand the concept of garbage collection, I have implemented a simple garbage collector in C++.
## Current Status
The project is currently in the development phase. ⚠️
## Getting Started
To get started with the project, follow the steps below:
1. Make sure you have installed the following in your environment:
- [GCC](https://gcc.gnu.org/)
- [Clang](https://clang.llvm.org/)
- [Valgrind](https://www.valgrind.org/)
- [Git](https://git-scm.com/)
- [Bash](https://www.gnu.org/software/bash/)
2. Clone the repository:
```bash
git clone https://github.com/silverlightning926/garbage-collector-cpp.git
```
3. Run The Code:
```bash
bash build_and_run.sh
```
4. Analyze The Code Using `clang-tidy`, `clang-format`, and `valgrind`:
```bash
bash analyze_code.sh
```
## Tools
### Clang-Tidy
[Clang-Tidy](https://clang.llvm.org/extra/clang-tidy/) is a clang-based C++ "linter" tool. Its purpose is to provide an extensible framework for diagnosing and fixing typical programming errors, like style violations, interface misuse, or bugs that can be deduced via static analysis.
### Clang-Format
[Clang-Format](https://clang.llvm.org/docs/ClangFormat.html) is a tool to format C++ code. It can take a C++ source file and reformat it in a way that conforms to the style of the LLVM project.
### Valgrind
[Valgrind](https://www.valgrind.org/) is a programming tool for memory debugging, memory leak detection, and profiling. It is a dynamic analysis tool that runs your program in a completely instrumented environment that tracks memory allocations, reads, and writes.
## Logic
The logic of the garbage collector is mostly stored in the [GarbageCollector](src/garbage_collector.h) class.
The `GarbageCollector` class allows the user to allocate memory to a new object using the `allocate` method. The `allocate` method returns a pointer to the allocated memory. The user can then use this pointer to store the object.
The class periodically does what's called a "mark and sweep" operation. The `mark` method marks all the objects that are still in use. The `sweep` method then sweeps through the memory and deallocates the memory that is not in use (not marked by the `mark` method).
Currently, the GC marks and sweeps at a set point in the code, however, I plan on implementing a more dynamic approach in the future.
## Upcoming Features
- Implement dynamic scheduling for the mark and sweep operation.
- Implement short-lived and long-lived object separation.
- Implement better logging and printing of actions.
- Add Profiling and Benchmarking.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.