Skip to content

Commit 1f20732

Browse files
author
Anonymous
committed
update README.md
1 parent c44e54c commit 1f20732

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,10 @@ Racing is an efficient statistical Root-Cause Analysis (RCA) solution that emplo
66
<a href="https://www.usenix.org/conference/usenixsecurity24/presentation/xu-dandan"> <img alt="racing paper" width="200" src="paper.jpg"></a>
77
</p>
88

9-
## TL;DR
10-
11-
You may use our [Dockerfile](Dockerfile) to setup a testing environment.
12-
13-
```bash
14-
# 1. build racing-eval image
15-
docker build -t racing-eval:latest .
16-
# 2. run racing-eval container
17-
docker run --name racing-eval --init -d -v $PWD/examples:/Racing-eval/examples racing-eval:latest tail -f /dev/null
18-
# 3. attach to the container
19-
docker exec -ti racing-eval bash
20-
```
9+
## System Requirement
2110

22-
## Environment Setup
11+
Racing was evaluated on an x86 Ubuntu 20.04 machine. Before you start everything, make sure to set the following configurations on your host machine (as required by AFL fuzzing).
2312

24-
Before you start everything, make sure to set the following configurations on your host machine (as required by AFL fuzzing).
2513
```
2614
### use root permission if necessary
2715
@@ -33,7 +21,22 @@ echo performance | tee cpu*/cpufreq/scaling_governor
3321
echo 0 | tee /proc/sys/kernel/randomize_va_space
3422
```
3523

36-
Racing was evaluated on Ubuntu 20.04. To obtain a clean environment for testing, one can pull the `ubuntu:20.04` image and launch the following container.
24+
## TL;DR
25+
26+
You may use our [Dockerfile](Dockerfile) to setup a testing environment. It automatically performs steps `S1 & S2` below. After the image has been built, please jump to step `S3` to run the commands inside the `racing-eval` container.
27+
28+
```bash
29+
# 1. build racing-eval image
30+
docker build -t racing-eval:latest .
31+
# 2. run racing-eval container
32+
docker run --name racing-eval --init -d -v $PWD/examples:/Racing-eval/examples racing-eval:latest tail -f /dev/null
33+
# 3. attach to the container
34+
docker exec -ti racing-eval bash
35+
```
36+
37+
## S1. Environment Setup
38+
39+
To obtain a clean environment for testing, one can pull the `ubuntu:20.04` image and launch the following container.
3740
```
3841
# download racing code
3942
git clone https://github.com/RacingN4th/racing-code
@@ -54,7 +57,7 @@ tar -xzf pin*.tar.gz
5457
export PIN_ROOT="$PWD/pin-3.15-98253-gb56e429b1-gcc-linux"
5558
```
5659

57-
## Racing Build Steps
60+
## S2. Racing Build Steps
5861

5962
Racing consists of the following components
6063
- `InstTracer`: A simple tracer to extract instructions that are covered by a vulnerability PoC.
@@ -77,7 +80,7 @@ cd ${RACING_DIR}/Racing-final/llvm_mode
7780
make
7881
```
7982

80-
## Testing Steps
83+
## S3. Testing Steps
8184

8285
The `examples` folder contains the scripts for analyzing the 30 vulnerabilities used in our paper. To reproduce it, please refer to the following example:
8386
```bash

0 commit comments

Comments
 (0)