From cdd7c97c270408c330fcffd7d280e68b3678efe4 Mon Sep 17 00:00:00 2001
From: Harish Mahendrakar <harish.mahendrakar@ittiam.com>
Date: Tue, 20 Aug 2019 17:14:14 -0700
Subject: [PATCH] Add README.md for fuzzer

Instructions to build fuzzer target are now in README.md

Bug: 139761244
Test: Review
Change-Id: Id67f16910bb36752cba838e1f51733239cc6e58a
---
 fuzzer/README.md           | 69 ++++++++++++++++++++++++++++++++++++++
 fuzzer/hevc_dec_fuzzer.cpp | 43 ------------------------
 2 files changed, 69 insertions(+), 43 deletions(-)
 create mode 100644 fuzzer/README.md

diff --git a/fuzzer/README.md b/fuzzer/README.md
new file mode 100644
index 0000000..b883e37
--- /dev/null
+++ b/fuzzer/README.md
@@ -0,0 +1,69 @@
+# Fuzzer for libhevc decoder
+
+This describes steps to build hevc_dec_fuzzer binary.
+
+## Linux x86/x64
+
+###  Requirements
+- cmake (3.5 or above)
+- make
+- clang (6.0 or above)
+  needs to support -fsanitize=fuzzer, -fsanitize=fuzzer-no-link
+
+### Steps to build
+Clone libhevc repository
+```
+$ git clone https://android.googlesource.com/platform/external/libhevc
+```
+Create a directory inside libhevc and change directory
+```
+ $ cd libhevc
+ $ mkdir build
+ $ cd build
+```
+Build libhevc using cmake
+```
+ $ CC=clang CXX=clang++ cmake ../ \
+   -DSANITIZE=fuzzer-no-link,address,signed-integer-overflow
+ $ make
+ ```
+Build the fuzzer
+```
+ $ clang++ -std=c++11 -fsanitize=fuzzer,address -I.  -I../  -I../common \
+   -I../decoder -Wl,--start-group ../fuzzer/hevc_dec_fuzzer.cpp \
+   -o ./hevc_dec_fuzzer ./libhevcdec.a -Wl,--end-group
+```
+
+### Steps to run
+Create a directory CORPUS_DIR and copy some elementary hevc files to that folder
+To run the fuzzer
+```
+$ ./hevc_dec_fuzzer CORPUS_DIR
+```
+
+## Android
+
+### Steps to build
+Build the fuzzer
+```
+  $ SANITIZE_TARGET=address SANITIZE_HOST=address mmma -j$(nproc) \
+    external/libhevc/fuzzer
+```
+
+### Steps to run
+Create a directory CORPUS_DIR and copy some elementary hevc files to that folder
+Push this directory to device.
+
+To run on device
+```
+  $ adb sync data
+  $ adb shell /data/fuzz/hevc_dec_fuzzer CORPUS_DIR
+```
+To run on host
+```
+  $ $ANDROID_HOST_OUT/fuzz/hevc_dec_fuzzer CORPUS_DIR
+```
+
+## References:
+ * http://llvm.org/docs/LibFuzzer.html
+ * https://github.com/google/oss-fuzz
diff --git a/fuzzer/hevc_dec_fuzzer.cpp b/fuzzer/hevc_dec_fuzzer.cpp
index 82b97e6..be70ef5 100644
--- a/fuzzer/hevc_dec_fuzzer.cpp
+++ b/fuzzer/hevc_dec_fuzzer.cpp
@@ -17,49 +17,6 @@
  *****************************************************************************
  * Originally developed and contributed by Ittiam Systems Pvt. Ltd, Bangalore
  */
-/*
- * Fuzzer for libhevc decoder
- * ==========================
- * Requirements
- * --------------
- * Requires Clang 6.0 or above (needs to support -fsanitize=fuzzer,
- * -fsanitize=fuzzer-no-link)
- *
-
- * Steps to build
- * --------------
- * Clone libhevc repository
-   $ git clone https://android.googlesource.com/platform/external/libhevc
-
- * Create a directory inside libhevc and change directory
-   $ cd libhevc
-   $ mkdir hevc_dec_fuzzer
-   $ cd hevc_dec_fuzzer/
-
- * Build libavc using cmake.
-   $ CC=clang CXX=clang++ cmake ../ \
-     -DSANITIZE=fuzzer-no-link,address,signed-integer-overflow
-
- * Build libhevcdec
-   $ make -j32
-
- * Build hevc fuzzer
-   $ clang++ -std=c++11 -fsanitize=fuzzer,address -I.  -I../ \
-   -I../common -I../decoder -Wl,--start-group \
-   ../fuzzer/hevc_dec_fuzzer.cpp -o ./hevc_dec_fuzzer \
-   ./libhevcdec.a -Wl,--end-group
-
- * create a corpus directory and copy some elementary hevc files there.
- * Empty corpus directoy also is acceptable, though not recommended
-   $ mkdir CORPUS && cp some-files CORPUS
-
- * Run fuzzing:
-   $ ./hevc_dec_fuzzer CORPUS
-
- * References:
- * http://llvm.org/docs/LibFuzzer.html
- * https://github.com/google/oss-fuzz
- */
 
 #include <malloc.h>
 #include <stddef.h>