about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorvan Hauser <vh@thc.org>2019-07-15 11:22:54 +0200
committervan Hauser <vh@thc.org>2019-07-15 11:22:54 +0200
commit32525238238e96ec0ce64a36f70558f76bc90ff5 (patch)
tree21f063de67af172c0fb55ea129c34cc2d661cf1c /docs
parent2628f9f61b4c2c0dda8b830ceae504d78f8acf69 (diff)
downloadafl++-32525238238e96ec0ce64a36f70558f76bc90ff5.tar.gz
fixing commit fuckup
Diffstat (limited to 'docs')
-rw-r--r--docs/ChangeLog8
-rw-r--r--docs/README3
-rw-r--r--docs/env_variables.txt22
3 files changed, 21 insertions, 12 deletions
diff --git a/docs/ChangeLog b/docs/ChangeLog
index 9cdca49b..116029ea 100644
--- a/docs/ChangeLog
+++ b/docs/ChangeLog
@@ -17,9 +17,9 @@ sending a mail to <afl-users+subscribe@googlegroups.com>.
 Version ++2.52d (tbd):
 -----------------------------
 
-  - added instrim a much better llvm_mode instrumentation
-    (https://github.com/csienslab/instrim)
-  - added MOpt (github.com/puppet-meteor/MOpt-AFL) mode
+  - added instrim, a much faster llvm_mode instrumentation at the cost of
+    path discovery. See llvm_mode/README.instrim (https://github.com/csienslab/instrim)
+  - added MOpt (github.com/puppet-meteor/MOpt-AFL) mode, see docs/README.MOpt
   - added code to make it more portable to other platforms than Intel Linux
   - added never zero counters for afl-gcc and optional (because of an
     optimization issue in llvm < 9) for llvm_mode (AFL_LLVM_NEVER_ZERO=1)
@@ -41,8 +41,6 @@ Version ++2.52d (tbd):
     tests as the random numbers are deterministic then
   - llvm_mode LAF_... env variables can now be specified as AFL_LLVM_LAF_...
     that is longer but in line with other llvm specific env vars
-  - ... your idea or patch?
-
 
 
 -----------------------------
diff --git a/docs/README b/docs/README
index 54e3e4a4..3a6c2921 100644
--- a/docs/README
+++ b/docs/README
@@ -23,8 +23,7 @@ american fuzzy lop plus plus
   https://github.com/puppet-meteor/MOpt-AFL  
 
   Also newly integrated is instrim, a very effective CFG llvm_mode
-  instrumentation implementation which replaced the original afl one and is
-  from https://github.com/csienslab/instrim
+  instrumentation implementation from https://github.com/csienslab/instrim
 
   A more thorough list is available in the PATCHES file.
 
diff --git a/docs/env_variables.txt b/docs/env_variables.txt
index 8e2723d7..e58327b4 100644
--- a/docs/env_variables.txt
+++ b/docs/env_variables.txt
@@ -109,11 +109,21 @@ Then there are a few specific features that are only available in llvm_mode:
 
     See llvm_mode/README.whitelist for more information.
 
-  OTHER
-  =====
-    - Setting LOOPHEAD=1 optimized loops. afl-fuzz will only be able to
-      see the path the loop took, but not how many times it was called
-      (unless its a complex loop).
+  INSTRIM
+  =======
+    This feature increases the speed by whopping 20% but at the cost of a
+    lower path discovery and thefore coverage.
+
+    - Setting AFL_LLVM_INSTRIM activates this mode
+
+    - Setting AFL_LLVM_INSTRIM LOOPHEAD=1 expands on INSTRIM to optimize loops.
+      afl-fuzz will only be able to see the path the loop took, but not how
+      many times it was called (unless its a complex loop).
+
+    See llvm_mode/README.instrim
+
+  NOT_ZERO
+  ========
 
     - Setting AFL_LLVM_NOT_ZERO=1 during compilation will use counters
       that skip zero on overflow. This is the default for llvm >= 9,
@@ -121,6 +131,8 @@ Then there are a few specific features that are only available in llvm_mode:
       slowdown due a performance issue that is only fixed in llvm 9+.
       This feature increases path discovery by a little bit.
 
+    See llvm_mode/README.neverzero
+
 3) Settings for afl-fuzz
 ------------------------