Skip to content

Commit 2ce573e

Browse files
committed
correct readme
1 parent b5301cb commit 2ce573e

File tree

1 file changed

+16
-29
lines changed

1 file changed

+16
-29
lines changed

README.md

Lines changed: 16 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# RocksDB Equipped With SuRF
22

33
## Install Dependencies
4-
sudo apt-get install build-essential cmake libsnappy
4+
sudo apt-get install build-essential cmake libgtest.dev libsnappy-dev
55
cd /usr/src/gtest
66
sudo cmake CMakeLists.txt
77
sudo make
@@ -15,52 +15,39 @@
1515
cmake -DWITH_SNAPPY=ON ..
1616
make -j 8
1717

18-
## Generate Workload and RocksDB Instances
19-
The experiments presented in our
18+
## Generate Workloads and RocksDB Instances
19+
The experiment results presented in our
2020
[SIGMOD paper](http://www.cs.cmu.edu/~huanche1/publications/surf_paper.pdf)
21-
uses 100GB datasets. Because it takes a long time to run, we scale the experiments
22-
down to 2GB datasets (the 100GB experiment configs are still included in
23-
filter_experiment/filter_experiment.cc, commented out).
21+
uses 100GB datasets. Because it takes a long time to run, we scale
22+
down to 2GB datasets here (the 100GB configs are still included in
23+
**filter_experiment/filter_experiment.cc**, but commented out).
2424

2525
cd filter_experiment
2626
python poisson.py
2727
mkdir data_no_filter data_bloom data_surf
2828

29-
Run the executable "../build/filter_experiment/filter_experiment" will show the usage information:
29+
Run the executable **../build/filter_experiment/filter_experiment** will show the usage information:
3030
Usage:
3131
arg 1: path to datafiles
32-
arg 2: filter type
33-
0: no filter
34-
1: Bloom filter
35-
2: SuRF
36-
3: SuRF Hash
37-
4: SuRF Real
38-
arg 3: compression?
39-
0: no compression
40-
1: Snappy
41-
arg 4: use direct I/O?
42-
0: no
43-
1: yes
44-
arg 5: query type
45-
0: init
46-
1: point query
47-
2: open range query
48-
3: closed range query
32+
arg 2: filter type 0: no filter 1: Bloom filter 2: SuRF 3: SuRF Hash 4: SuRF Real
33+
arg 3: compression? 0: no compression 1: Snappy
34+
arg 4: use direct I/O? 0: no 1: yes
35+
arg 5: query type 0: init 1: point query 2: open range query 3: closed range query
4936
arg 6: range size
5037
arg 7: warmup # of queries
5138

52-
To initialize the RocksDB instances with no filter, bloom filters and SuRF (with real suffixes):
39+
To initialize the RocksDB instances with no filter, bloom filters and SuRFs (with real suffixes):
5340

5441
../build/filter_experiment/filter_experiment data_no_filter 0 1 0 0 0 0
5542
../build/filter_experiment/filter_experiment data_bloom 1 1 0 0 0 0
5643
../build/filter_experiment/filter_experiment data_surf 4 1 0 0 0 0
5744

58-
## Run Benchmark
45+
## Run Benchmarks
5946
You may want to clear system cache (echo 3 | sudo tee /proc/sys/vm/drop_caches)
6047
before running each experiment. The source file for the experiments is
61-
"filter_experiment/filter_experiment.cc". To get correct I/O counts, you need
62-
to specify the device in function "getIOCount()" and "printIO()".
63-
filter_experiment.cc includes more configurations (e.g., specify filter sizes)
48+
**filter_experiment/filter_experiment.cc**. To get correct I/O counts, you need
49+
to specify the device in function **getIOCount()** and **printIO()**.
50+
**filter_experiment.cc** includes more configurations (e.g., specify filter sizes)
6451
to run different experiments besides the following examples:
6552

6653
// point queries

0 commit comments

Comments
 (0)