[libc-commits] [libc] e6d5680 - [libc][docs] Update the fuzzing doc to better reflect the current state.

Siva Chandra Reddy via libc-commits libc-commits at lists.llvm.org
Wed Apr 20 08:33:40 PDT 2022


Author: Siva Chandra Reddy
Date: 2022-04-20T15:33:20Z
New Revision: e6d56802f83b37609ebf03f2348b87ac2d10b074

URL: https://github.com/llvm/llvm-project/commit/e6d56802f83b37609ebf03f2348b87ac2d10b074
DIFF: https://github.com/llvm/llvm-project/commit/e6d56802f83b37609ebf03f2348b87ac2d10b074.diff

LOG: [libc][docs] Update the fuzzing doc to better reflect the current state.

Reviewed By: lntue

Differential Revision: https://reviews.llvm.org/D123923

Added: 
    

Modified: 
    libc/docs/fuzzing.rst

Removed: 
    


################################################################################
diff  --git a/libc/docs/fuzzing.rst b/libc/docs/fuzzing.rst
index 699a57cc3b4a3..5cca67826f150 100644
--- a/libc/docs/fuzzing.rst
+++ b/libc/docs/fuzzing.rst
@@ -1,15 +1,18 @@
-Fuzzing for LLVM-libc
----------------------
+Fuzzing for LLVM-libc functions
+===============================
 
-Fuzzing tests are used to ensure quality and security of LLVM-libc
-implementations.
+Fuzz tests are used to ensure quality and security of LLVM-libc implementations.
+All fuzz tests live under the directory named ``fuzzing``. Within this
+directory, the fuzz test for a libc function lives in the same nested directory
+as its implementation in the toplevel ``src`` directory. The build target
+``libc-fuzzer`` builds all of the enabled fuzz tests (but does not run them).
 
-Each fuzzing test lives under the fuzzing directory in a subdirectory
-corresponding with the src layout.
+Types of fuzz tests
+===================
 
-Currently we use system libc for functions that have yet to be implemented,
-however as they are implemented the fuzzers will be changed to use our
-implementation to increase coverage for testing.
-
-Fuzzers will be run on `oss-fuzz <https://github.com/google/oss-fuzz>`_ and the
-check-libc target will ensure that they build correctly.
+As of this writing, there are two 
diff erent kinds of fuzz tests. One kind are
+the traditional fuzz tests which test one function at a time and only that
+particular function. The other kind of tests are what we call as the
+
diff erential fuzz tests. These tests compare the behavior of LLVM libc
+implementations with the behavior of the corresponding functions from the system
+libc.


        


More information about the libc-commits mailing list