This repository contains a Moka cache driver for the
Caffeine Simulator. The driver enables the Caffeine Simulator
to run workloads against Moka cache (moka::sync::Cache) to measure cache hit vs.
miss ratios and generate charts.
The Caffeine Simulator is written in Java but Moka cache is written in Rust. This driver uses Java Native Interface (JNI) to bridge the gap between the two languages.
The driver consists of two parts:
- A Java class that implements the
Policyinterface of the Simulator. It callsnative(Rust) functions. - A Rust library that wraps Moka cache and implements the functions called by the
Java class.
- This library uses
jnicrate, which provides a safe wrapper around the JNI API.
- This library uses
The Rust library is compiled into a dynamic library that is loaded into the Java VM at runtime.
- Java JDK to build the Caffeine Simulator and the Java part of the driver.
- Rust stable toolchain (1.75 or newer) to build Moka and the Rust part of the driver.
Suppose you use ~/sim as the working directory.
Clone this repository:
$ SIM=~/sim
$ cd $SIM
$ git clone https://github.com/moka-rs/caffeine-sim-drivers.gitBuild the Rust part of the driver:
$ cd $SIM/caffeine-sim-drivers/moka-driver-rs
$ cargo build --releaseClone Caffeine's repository, and checkout a specific Git revision:
$ REVISION=4ba734a6cf2f7243c77d2ad8ea9d941f6e36175c
$ cd $SIM
$ git clone https://github.com/ben-manes/caffeine.git
$ (cd caffeine && git checkout $REVISION)Copy the Java part of the driver into the Caffeine repository:
$ POL_DIR=simulator/src/main/java/io/crates/moka/cache/simulator/policy/product/
$ mkdir -p $SIM/caffeine/$POL_DIR
$ cp -p $SIM/caffeine-sim-drivers/moka-driver-java/MokaPolicy.java $SIM/caffeine/$POL_DIR/Copy a patch file into the Caffeine repository:
$ cp -p $SIM/caffeine-sim-drivers/moka-driver-java/registry-patch.diff $SIM/caffeine/Apply the patch:
$ cd $SIM/caffeine
$ git apply registry-patch.diffCreate application.conf from the template:
$ cd $SIM/caffeine/simulator/src/main/resources/
$ cp -p reference.conf application.confEdit application.conf and add the following line in the policies section:
policies = [
opt.Clairvoyant,
...
linked.Lru,
...
sketch.WindowTinyLfu,
...
product.Moka, # <--- Add this line.
]
admission = [
Always,
TinyLfu,
]Build and run the Caffeine Simulator:
## The path to the directory containing the dynamic library.
$ DRV_LIB=$SIM/caffeine-sim-drivers/moka-driver-rs/target/release
## The path to the directory containing the ARC trace files.
## Replace `/path/to/...` with the real path.
$ ARC_DIR=/path/to/arc-trace-directory
## The path to the directory containing the Corda trace files.
$ CORDA_DIR=$SIM/caffeine/simulator/src/main/resources/com/github/benmanes/caffeine/cache/simulator/parser/corda/
$ cd $SIM/caffeine
## Run the simulator against the ARC S3 trace file.
$ ./gradlew simulator:simulate -q \
-Dcaffeine.simulator.files.paths.0=arc:$ARC_DIR/S3.lis \
--maximumSize=100_000,200_000,300_000,400_000,500_000,600_000,700_000,800_000 \
-PjvmArgs="-XX:+UseParallelGC,-Xmx8g,-Djava.library.path=$DRV_LIB" \
--theme=light
$ mv $SIM/caffeine/simulator/build/reports/simulate{,-arc-s3}
## Run the simulator against the Corda vault service large trace file.
$ ./gradlew simulator:simulate -q \
-Dcaffeine.simulator.files.paths.0=corda:$CORDA_DIR/trace_vaultservice_large.gz \
--maximumSize=200_000,400_000,600_000,800_000,1_000_000,1_200_000,1_400_000,1_600_000 \
-PjvmArgs="-XX:+UseParallelGC,-Xmx8g,-Djava.library.path=$DRV_LIB" \
--theme=light
$ mv $SIM/caffeine/simulator/build/reports/simulate{,-corda-large}If you want to modify the driver, e.g., to drive your own cache implementation, check
out the driver's codes and the "Getting Started" section of the jni crate's
documentation:
- Driver's source code:
- Java part: MokaPolicy.java
- Rust part: src/lib.rs
jnicrate: Getting Started
The Apache License 2.0. See LICENSE for details.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent