https://github.com/chakib-belgaid/jreferral
An open-source tool that recommends the most energy efficient JVM configuration for java software
https://github.com/chakib-belgaid/jreferral
benchmark energy energy-consumption energy-efficiency java jvm optimization
Last synced: 5 months ago
JSON representation
An open-source tool that recommends the most energy efficient JVM configuration for java software
- Host: GitHub
- URL: https://github.com/chakib-belgaid/jreferral
- Owner: chakib-belgaid
- Created: 2021-04-27T14:27:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-27T12:12:20.000Z (over 2 years ago)
- Last Synced: 2025-06-09T18:07:04.885Z (6 months ago)
- Topics: benchmark, energy, energy-consumption, energy-efficiency, java, jvm, optimization
- Language: Jupyter Notebook
- Homepage:
- Size: 2.4 MB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# JReferral
A tool that run your java program through multiple versions of JVMs and optimisation options to recommand the most energry efficiant configuration.
## Requirements
- **Docker** : we use a docker image for testing and isolating the JVM
- **Linux** : Our tool is based on *RAPL* sensors to measure energy
- **Python 3.5+** : for the reporting purpose
## How to use
1. Choose The configurations to be tested in th file [jvms.sh](./src/jvms.sh)
- Uncomment what should be included during the tests
2. Run [build-images.sh](./src/buildi-images.sh) that will build the docker images for respective jvms
- You can add the option **-u** to setup the username for docker images
- The images will have the format***username/jvm:version**
3. Replace the word **java** with **src/jrecommand.sh** in your command
- Example
```
java -jar example.jar arg1 arg2 ...
will be
./jreferral.sh -jar example.jar arg1 arg2 ...
```
You will find the results in `data.csv` and the execution log in `exp.log`
### Note:
Due to security reasons, you need sudo access in order to measure the energy
## Bulk Benchmarking
If you want to test multiple benchmarks you can use [bulk.sh](./src/bulk.sh), to do So
1. Put your benchmarks in a file as an exmple `example_bulks.sh`
2. Run the script [bulk.sh](./src/bulk.sh) giving him as entry the path of your *bulks_file*
- Example
```
./src/bulk.sh example_bulks.sh
```
## Plotting the results
With the option `-p` the program will generate a pdf file containaing all the measures aka *execution time* and *energies* for each benchmark.
- In order to have more visible name for the different tunning options you can put them in the [tagging file](src/jvms-option-names.sh) using the following format
`options` **TAG** `visible tag`
- Example:
```
-XX:+UnlockExperimentalVMOptions -XX:+UseEpsilonGC -XX:+AlwaysPreTouch TAG EpsilonGC
```
The tests with this options will take the name of EpsilonGC in the graphs
## Flags and options
- For both `jreferral.sh` and `bulk.sh`
|**Flag**|**Description**|**Default value**|
|--------|---------------|:---------------:|
| -u *name* | The username of docker images | user |
| -o *filename* | The filename where the all the measures should be put in | data.csv|
| -l *filename* | Redirection of the output of the tests | exp.log |
| -n *Number* | The number of iterations that should be run for each configuration | 1 |
| -s *Duration* | Time to wait between two consecutive tests (in order to avoid the test impacting each others ) | 3s | sec|
| -d | print the *DRAM* energy and *CPU* energy seperately | False |
| -p | generate a *pdf* that containes all the measures in format of boxplot | False |
## Example
### Recap
This is an example to test the energy consumption of [zip4j](https://github.com/srikanth-lingala/zip4j)
and for the detailed version (aka -d)
### Plots
Energy consumption of **CPU**
Energy consumption of **DRAM**
**Execution of Time**
