Skip to content

Update README to mention how to set a GC plan #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update README to mention how to set a GC plan #219

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d26a2a0
Update README to mention how to set a GC plan
qinsoon May 17, 2023
3cf947b
Merge branch 'master' into choose-plan-in-readme
qinsoon Oct 16, 2023
05f7043
Link to mmtk-core doc about a list of plans
qinsoon Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,10 @@ $ VO_BIT=1 make CONF=linux-x86_64-normal-server-$DEBUG_LEVEL THIRD_PARTY_HEAP=$P

## Test

We support all the MMTk GC plans in OpenJDK. A full list of MMTk plans can be found [here](https://docs.mmtk.io/api/mmtk/util/options/enum.PlanSelector.html).
When you run with the OpenJDK build from previous steps, you can choose one of the plans by setting an environment variable `MMTK_PLAN` to one of the plan names.
In the following examples, we use the generational immix plan, `GenImmix`.

### Run HelloWorld (without MMTk)

```console
Expand All @@ -219,7 +223,7 @@ class HelloWorld {
}
}
$ ./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/javac HelloWorld.java
$ ./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/java HelloWorld
$ MMTK_PLAN=GenImmix ./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/java HelloWorld
Hello World!
```

Expand Down Expand Up @@ -263,7 +267,7 @@ $ wget https://sourceforge.net/projects/dacapobench/files/9.12-bach-MR1/dacapo-9
Run a DaCapo benchmark (e.g. `lusearch`):

```console
$ ./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/java -XX:+UseThirdPartyHeap -Xms512M -Xmx512M -jar ./dacapo-9.12-MR1-bach.jar lusearch
$ MMTK_PLAN=GenImmix ./build/linux-x86_64-normal-server-$DEBUG_LEVEL/jdk/bin/java -XX:+UseThirdPartyHeap -Xms512M -Xmx512M -jar ./dacapo-9.12-MR1-bach.jar lusearch
Using scaled threading model. 24 processors detected, 24 threads used to drive the workload, in a possible range of [1,64]
===== DaCapo 9.12-MR1 lusearch starting =====
4 query batches completed
Expand Down