about summary refs log tree commit diff
path: root/instrumentation/README.cmplog.md
blob: 5f855e1f72761386bd0186792358c8e436a2b6f2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# CmpLog instrumentation

The CmpLog instrumentation enables the logging of the comparisons operands in a
shared memory.

These values can be used by various mutators built on top of it.
At the moment we support the RedQueen mutator (input-2-state instructions only).

## Build

To use CmpLog, you have to build two versions of the instrumented target
program.

The first version is built using the regular AFL++ instrumentation.

The second one, the CmpLog binary, with setting AFL_LLVM_CMPLOG during the compilation.

For example:

```
./configure --cc=~/path/to/afl-clang-fast
make
cp ./program ./program.afl
make clean
export AFL_LLVM_CMPLOG=1
./configure --cc=~/path/to/afl-clang-fast
make
cp ./program ./program.cmplog
```

## Use

AFL++ has the new -c option that needs to be used to specify the CmpLog binary (the second
build).

For example:

```
afl-fuzz -i input -o output -c ./program.cmplog -m none -- ./program.afl @@
```

Be sure to use `-m none` because CmpLog can map a lot of pages.