docs/fuzz: add some information about OSS-Fuzz
Signed-off-by: Alexander Bulekov <alxndr@bu.edu> Reviewed-by: Darren Kenny <darren.kenny@oracle.com> Message-Id: <20210117230924.449676-3-alxndr@bu.edu>
This commit is contained in:
parent
8630b43f11
commit
3ca45fb4d2
@ -180,6 +180,36 @@ To ensure that these env variables have been configured correctly, we can use::
|
|||||||
|
|
||||||
The output should contain a complete list of matched MemoryRegions.
|
The output should contain a complete list of matched MemoryRegions.
|
||||||
|
|
||||||
|
OSS-Fuzz
|
||||||
|
--------
|
||||||
|
QEMU is continuously fuzzed on `OSS-Fuzz` __(https://github.com/google/oss-fuzz).
|
||||||
|
By default, the OSS-Fuzz build will try to fuzz every fuzz-target. Since the
|
||||||
|
generic-fuzz target requires additional information provided in environment
|
||||||
|
variables, we pre-define some generic-fuzz configs in
|
||||||
|
``tests/qtest/fuzz/generic_fuzz_configs.h``. Each config must specify:
|
||||||
|
|
||||||
|
- ``.name``: To identify the fuzzer config
|
||||||
|
|
||||||
|
- ``.args`` OR ``.argfunc``: A string or pointer to a function returning a
|
||||||
|
string. These strings are used to specify the ``QEMU_FUZZ_ARGS``
|
||||||
|
environment variable. ``argfunc`` is useful when the config relies on e.g.
|
||||||
|
a dynamically created temp directory, or a free tcp/udp port.
|
||||||
|
|
||||||
|
- ``.objects``: A string that specifies the ``QEMU_FUZZ_OBJECTS`` environment
|
||||||
|
variable.
|
||||||
|
|
||||||
|
To fuzz additional devices/device configuration on OSS-Fuzz, send patches for
|
||||||
|
either a new device-specific fuzzer or a new generic-fuzz config.
|
||||||
|
|
||||||
|
Build details:
|
||||||
|
|
||||||
|
- The Dockerfile that sets up the environment for building QEMU's
|
||||||
|
fuzzers on OSS-Fuzz can be fund in the OSS-Fuzz repository
|
||||||
|
__(https://github.com/google/oss-fuzz/blob/master/projects/qemu/Dockerfile)
|
||||||
|
|
||||||
|
- The script responsible for building the fuzzers can be found in the
|
||||||
|
QEMU source tree at ``scripts/oss-fuzz/build.sh``
|
||||||
|
|
||||||
Implementation Details / Fuzzer Lifecycle
|
Implementation Details / Fuzzer Lifecycle
|
||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user