diff options
| Commit | 4deec0ce53bf6475c3ed8fc70d1cd17d31afb705 (patch) | |
|---|---|---|
| Author | 2021-01-09 16:19:05 +0200 | |
| Committer | 2021-09-13 22:25:45 +0300 | |
| Files | b2035ae280217f92341d66e3e102b005ce855a11 | |
| IPL-4deec0ce53bf6475c3ed8fc70d1cd17d31afb705.tar IPL-4deec0ce53bf6475c3ed8fc70d1cd17d31afb705.tar.gz IPL-4deec0ce53bf6475c3ed8fc70d1cd17d31afb705.zip | ||
| Parent | ba6371ce37f2eccbec3a3352be58cb8d4989dc17 (diff) | |
Add readme for the GC bench test
1 files changed, 21 insertions, 0 deletions
| -rw-r--r-- | gctest/README.md | 21 |
diff --git a/gctest/README.md b/gctest/README.md new file mode 100644 index 0000000..57528fb --- /dev/null +++ b/gctest/README.md @@ -0,0 +1,21 @@ +# GC Test Bench
+
+A program to stress test garbage collector implementations.
+
+## Building
+
+The program is implemented as a static library, that has to be linked together
+with the garbage collector implementation to produce a test program.
+
+## Adding a new Garbage Collector implementation
+
+1. Implement the `GarbageCollector` interface from `gc.h` and the factory
+ function
+2. Add a new target in the `genie.lua` project
+
+## Running
+
+Running the program produces a `program.json` that can be open in
+`chrome://tracing` to allow analysis of the mutator vs garbage collector CPU
+usage and memory usage.
+
|