[llvm-mc-fuzzer] Document llvm-mc-fuzzer in LibFuzzer.rst.
authorDaniel Sanders <daniel.sanders@imgtec.com>
Fri, 18 Sep 2015 10:47:45 +0000 (10:47 +0000)
committerDaniel Sanders <daniel.sanders@imgtec.com>
Fri, 18 Sep 2015 10:47:45 +0000 (10:47 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@247979 91177308-0d34-0410-b5e6-96231b3b80d8

docs/LibFuzzer.rst

index 97319bec0022a4a34a386bbed2e5b75f74cafe67..8d4972296edef4a2d807a86616949e443e549a7d 100644 (file)
@@ -350,6 +350,23 @@ llvm-as-fuzzer
 
 Tracking bug: https://llvm.org/bugs/show_bug.cgi?id=24639
 
+llvm-mc-fuzzer
+--------------
+
+This tool fuzzes the MC layer. Currently it is only able to fuzz the
+disassembler but it is hoped that assembly, and round-trip verification will be
+added in future.
+
+When run in dissassembly mode, the inputs are opcodes to be disassembled. The
+fuzzer will consume as many instructions as possible and will stop when it
+finds an invalid instruction or runs out of data.
+
+Please note that the command line interface differs from that of other fuzzers.
+The fuzzer arguments are specified with ``-fuzzer-args`` while other arguments
+control the operation mode and target in a similar manner to ``llvm-mc``.
+
+Unfortunately, this fuzzer is currently unable to use the -jobs option.
+
 Buildbot
 --------