From: Alexander Bulekov <alxndr@bu.edu>
To: qemu-devel@nongnu.org
Cc: Thomas Huth <thuth@redhat.com>, Alexander Bulekov <alxndr@bu.edu>,
f4bug@amsat.org, darren.kenny@oracle.com, bsd@redhat.com,
stefanha@redhat.com, pbonzini@redhat.com,
dimastep@yandex-team.ru
Subject: [PATCH v6 12/16] fuzz: Add instructions for using generic-fuzz
Date: Wed, 21 Oct 2020 17:09:18 -0400 [thread overview]
Message-ID: <20201021210922.572955-13-alxndr@bu.edu> (raw)
In-Reply-To: <20201021210922.572955-1-alxndr@bu.edu>
Reviewed-by: Darren Kenny <darren.kenny@oracle.com>
Signed-off-by: Alexander Bulekov <alxndr@bu.edu>
---
docs/devel/fuzzing.txt | 39 +++++++++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/docs/devel/fuzzing.txt b/docs/devel/fuzzing.txt
index 96d71c94d7..03585c1a9b 100644
--- a/docs/devel/fuzzing.txt
+++ b/docs/devel/fuzzing.txt
@@ -125,6 +125,45 @@ provided by libfuzzer. Libfuzzer passes a byte array and length. Commonly the
fuzzer loops over the byte-array interpreting it as a list of qtest commands,
addresses, or values.
+== The Generic Fuzzer ==
+Writing a fuzz target can be a lot of effort (especially if a device driver has
+not be built-out within libqos). Many devices can be fuzzed to some degree,
+without any device-specific code, using the generic-fuzz target.
+
+The generic-fuzz target is capable of fuzzing devices over their PIO, MMIO,
+and DMA input-spaces. To apply the generic-fuzz to a device, we need to define
+two env-variables, at minimum:
+
+QEMU_FUZZ_ARGS= is the set of QEMU arguments used to configure a machine, with
+the device attached. For example, if we want to fuzz the virtio-net device
+attached to a pc-i440fx machine, we can specify:
+QEMU_FUZZ_ARGS="-M pc -nodefaults -netdev user,id=user0 \
+ -device virtio-net,netdev=user0"
+
+QEMU_FUZZ_OBJECTS= is a set of space-delimited strings used to identify the
+MemoryRegions that will be fuzzed. These strings are compared against
+MemoryRegion names and MemoryRegion owner names, to decide whether each
+MemoryRegion should be fuzzed. These strings support globbing. For the
+virtio-net example, we could use QEMU_FUZZ_OBJECTS=
+ * 'virtio-net'
+ * 'virtio*'
+ * 'virtio* pcspk' (Fuzz the virtio devices and the PC speaker...)
+ * '*' (Fuzz the whole machine)
+
+The "info mtree" and "info qom-tree" monitor commands can be especially useful
+for identifying the MemoryRegion and Object names used for matching.
+
+As a generic rule-of-thumb, the more MemoryRegions/Devices we match, the greater
+the input-space, and the smaller the probability of finding crashing inputs for
+individual devices. As such, it is usually a good idea to limit the fuzzer to
+only a few MemoryRegions.
+
+To ensure that these env variables have been configured correctly, we can use:
+
+./qemu-fuzz-i386 --fuzz-target=generic-fuzz -runs=0
+
+The output should contain a complete list of matched MemoryRegions.
+
= Implementation Details =
== The Fuzzer's Lifecycle ==
--
2.28.0
next prev parent reply other threads:[~2020-10-21 21:37 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-21 21:09 [PATCH v6 00/16] Add a Generic Virtual Device Fuzzer Alexander Bulekov
2020-10-21 21:09 ` [PATCH v6 01/16] memory: Add FlatView foreach function Alexander Bulekov
2020-10-22 8:09 ` Darren Kenny
2020-10-21 21:09 ` [PATCH v6 02/16] fuzz: Add generic virtual-device fuzzer Alexander Bulekov
2020-10-22 9:12 ` Darren Kenny
2020-10-21 21:09 ` [PATCH v6 03/16] fuzz: Add PCI features to the generic fuzzer Alexander Bulekov
2020-10-21 21:09 ` [PATCH v6 04/16] fuzz: Add DMA support to the generic-fuzzer Alexander Bulekov
2020-10-21 21:09 ` [PATCH v6 05/16] fuzz: Declare DMA Read callback function Alexander Bulekov
2020-10-21 21:09 ` [PATCH v6 06/16] fuzz: Add fuzzer callbacks to DMA-read functions Alexander Bulekov
2020-10-21 21:09 ` [PATCH v6 07/16] fuzz: Add support for custom crossover functions Alexander Bulekov
2020-10-21 21:09 ` [PATCH v6 08/16] fuzz: add a DISABLE_PCI op to generic-fuzzer Alexander Bulekov
2020-10-21 21:09 ` [PATCH v6 09/16] fuzz: add a crossover function " Alexander Bulekov
2020-10-21 21:09 ` [PATCH v6 10/16] scripts/oss-fuzz: Add script to reorder a generic-fuzzer trace Alexander Bulekov
2020-10-21 21:09 ` [PATCH v6 11/16] scripts/oss-fuzz: Add crash trace minimization script Alexander Bulekov
2020-10-21 21:09 ` Alexander Bulekov [this message]
2020-10-21 21:09 ` [PATCH v6 13/16] fuzz: add an "opaque" to the FuzzTarget struct Alexander Bulekov
2020-10-22 9:14 ` Darren Kenny
2020-10-21 21:09 ` [PATCH v6 14/16] fuzz: add generic-fuzz configs for oss-fuzz Alexander Bulekov
2020-10-22 9:15 ` Darren Kenny
2020-10-21 21:09 ` [PATCH v6 15/16] fuzz: register predefined generic-fuzz configs Alexander Bulekov
2020-10-22 9:18 ` Darren Kenny
2020-10-21 21:09 ` [PATCH v6 16/16] scripts/oss-fuzz: remove the generic-fuzz target Alexander Bulekov
2020-10-22 9:32 ` Darren Kenny
2020-10-22 13:01 ` Alexander Bulekov
2020-10-22 13:13 ` Darren Kenny
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201021210922.572955-13-alxndr@bu.edu \
--to=alxndr@bu.edu \
--cc=bsd@redhat.com \
--cc=darren.kenny@oracle.com \
--cc=dimastep@yandex-team.ru \
--cc=f4bug@amsat.org \
--cc=pbonzini@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
--cc=thuth@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).