docs/devel/fuzzing.rst

   1 ========
   2 Fuzzing
   3 ========
   4
   5 This document describes the virtual-device fuzzing infrastructure in QEMU and
   6 how to use it to implement additional fuzzers.
   7
   8 Basics
   9 ------
  10
  11 Fuzzing operates by passing inputs to an entry point/target function. The
  12 fuzzer tracks the code coverage triggered by the input. Based on these
  13 findings, the fuzzer mutates the input and repeats the fuzzing.
  14
  15 To fuzz QEMU, we rely on libfuzzer. Unlike other fuzzers such as AFL, libfuzzer
  16 is an *in-process* fuzzer. For the developer, this means that it is their
  17 responsibility to ensure that state is reset between fuzzing-runs.
  18
  19 Building the fuzzers
  20 --------------------
  21
  22 *NOTE*: If possible, build a 32-bit binary. When forking, the 32-bit fuzzer is
  23 much faster, since the page-map has a smaller size. This is due to the fact that
  24 AddressSanitizer maps ~20TB of memory, as part of its detection. This results
  25 in a large page-map, and a much slower ``fork()``.
  26
  27 To build the fuzzers, install a recent version of clang:
  28 Configure with (substitute the clang binaries with the version you installed).
  29 Here, enable-sanitizers, is optional but it allows us to reliably detect bugs
  30 such as out-of-bounds accesses, use-after-frees, double-frees etc.::
  31
  32     CC=clang-8 CXX=clang++-8 /path/to/configure --enable-fuzzing \
  33                                                 --enable-sanitizers
  34
  35 Fuzz targets are built similarly to system targets::
  36
  37     make qemu-fuzz-i386
  38
  39 This builds ``./qemu-fuzz-i386``
  40
  41 The first option to this command is: ``--fuzz-target=FUZZ_NAME``
  42 To list all of the available fuzzers run ``qemu-fuzz-i386`` with no arguments.
  43
  44 For example::
  45
  46     ./qemu-fuzz-i386 --fuzz-target=virtio-scsi-fuzz
  47
  48 Internally, libfuzzer parses all arguments that do not begin with ``"--"``.
  49 Information about these is available by passing ``-help=1``
  50
  51 Now the only thing left to do is wait for the fuzzer to trigger potential
  52 crashes.
  53
  54 Useful libFuzzer flags
  55 ----------------------
  56
  57 As mentioned above, libFuzzer accepts some arguments. Passing ``-help=1`` will
  58 list the available arguments. In particular, these arguments might be helpful:
  59
  60 * ``CORPUS_DIR/`` : Specify a directory as the last argument to libFuzzer.
  61   libFuzzer stores each "interesting" input in this corpus directory. The next
  62   time you run libFuzzer, it will read all of the inputs from the corpus, and
  63   continue fuzzing from there. You can also specify multiple directories.
  64   libFuzzer loads existing inputs from all specified directories, but will only
  65   write new ones to the first one specified.
  66
  67 * ``-max_len=4096`` : specify the maximum byte-length of the inputs libFuzzer
  68   will generate.
  69
  70 * ``-close_fd_mask={1,2,3}`` : close, stderr, or both. Useful for targets that
  71   trigger many debug/error messages, or create output on the serial console.
  72
  73 * ``-jobs=4 -workers=4`` : These arguments configure libFuzzer to run 4 fuzzers in
  74   parallel (4 fuzzing jobs in 4 worker processes). Alternatively, with only
  75   ``-jobs=N``, libFuzzer automatically spawns a number of workers less than or equal
  76   to half the available CPU cores. Replace 4 with a number appropriate for your
  77   machine. Make sure to specify a ``CORPUS_DIR``, which will allow the parallel
  78   fuzzers to share information about the interesting inputs they find.
  79
  80 * ``-use_value_profile=1`` : For each comparison operation, libFuzzer computes
  81   ``(caller_pc&4095) | (popcnt(Arg1 ^ Arg2) << 12)`` and places this in the
  82   coverage table. Useful for targets with "magic" constants. If Arg1 came from
  83   the fuzzer's input and Arg2 is a magic constant, then each time the Hamming
  84   distance between Arg1 and Arg2 decreases, libFuzzer adds the input to the
  85   corpus.
  86
  87 * ``-shrink=1`` : Tries to make elements of the corpus "smaller". Might lead to
  88   better coverage performance, depending on the target.
  89
  90 Note that libFuzzer's exact behavior will depend on the version of
  91 clang and libFuzzer used to build the device fuzzers.
  92
  93 Generating Coverage Reports
  94 ---------------------------
  95
  96 Code coverage is a crucial metric for evaluating a fuzzer's performance.
  97 libFuzzer's output provides a "cov: " column that provides a total number of
  98 unique blocks/edges covered. To examine coverage on a line-by-line basis we
  99 can use Clang coverage:
 100
 101  1. Configure libFuzzer to store a corpus of all interesting inputs (see
 102     CORPUS_DIR above)
 103  2. ``./configure`` the QEMU build with ::
 104
 105     --enable-fuzzing \
 106     --extra-cflags="-fprofile-instr-generate -fcoverage-mapping"
 107
 108  3. Re-run the fuzzer. Specify $CORPUS_DIR/* as an argument, telling libfuzzer
 109     to execute all of the inputs in $CORPUS_DIR and exit. Once the process
 110     exits, you should find a file, "default.profraw" in the working directory.
 111  4. Execute these commands to generate a detailed HTML coverage-report::
 112
 113       llvm-profdata merge -output=default.profdata default.profraw
 114       llvm-cov show ./path/to/qemu-fuzz-i386 -instr-profile=default.profdata \
 115       --format html -output-dir=/path/to/output/report
 116
 117 Adding a new fuzzer
 118 -------------------
 119
 120 Coverage over virtual devices can be improved by adding additional fuzzers.
 121 Fuzzers are kept in ``tests/qtest/fuzz/`` and should be added to
 122 ``tests/qtest/fuzz/meson.build``
 123
 124 Fuzzers can rely on both qtest and libqos to communicate with virtual devices.
 125
 126 1. Create a new source file. For example ``tests/qtest/fuzz/foo-device-fuzz.c``.
 127
 128 2. Write the fuzzing code using the libqtest/libqos API. See existing fuzzers
 129    for reference.
 130
 131 3. Add the fuzzer to ``tests/qtest/fuzz/meson.build``.
 132
 133 Fuzzers can be more-or-less thought of as special qtest programs which can
 134 modify the qtest commands and/or qtest command arguments based on inputs
 135 provided by libfuzzer. Libfuzzer passes a byte array and length. Commonly the
 136 fuzzer loops over the byte-array interpreting it as a list of qtest commands,
 137 addresses, or values.
 138
 139 The Generic Fuzzer
 140 ------------------
 141
 142 Writing a fuzz target can be a lot of effort (especially if a device driver has
 143 not be built-out within libqos). Many devices can be fuzzed to some degree,
 144 without any device-specific code, using the generic-fuzz target.
 145
 146 The generic-fuzz target is capable of fuzzing devices over their PIO, MMIO,
 147 and DMA input-spaces. To apply the generic-fuzz to a device, we need to define
 148 two env-variables, at minimum:
 149
 150 * ``QEMU_FUZZ_ARGS=`` is the set of QEMU arguments used to configure a machine, with
 151   the device attached. For example, if we want to fuzz the virtio-net device
 152   attached to a pc-i440fx machine, we can specify::
 153
 154     QEMU_FUZZ_ARGS="-M pc -nodefaults -netdev user,id=user0 \
 155     -device virtio-net,netdev=user0"
 156
 157 * ``QEMU_FUZZ_OBJECTS=`` is a set of space-delimited strings used to identify
 158   the MemoryRegions that will be fuzzed. These strings are compared against
 159   MemoryRegion names and MemoryRegion owner names, to decide whether each
 160   MemoryRegion should be fuzzed. These strings support globbing. For the
 161   virtio-net example, we could use one of ::
 162
 163     QEMU_FUZZ_OBJECTS='virtio-net'
 164     QEMU_FUZZ_OBJECTS='virtio*'
 165     QEMU_FUZZ_OBJECTS='virtio* pcspk' # Fuzz the virtio devices and the speaker
 166     QEMU_FUZZ_OBJECTS='*' # Fuzz the whole machine``
 167
 168 The ``"info mtree"`` and ``"info qom-tree"`` monitor commands can be especially
 169 useful for identifying the ``MemoryRegion`` and ``Object`` names used for
 170 matching.
 171
 172 As a generic rule-of-thumb, the more ``MemoryRegions``/Devices we match, the
 173 greater the input-space, and the smaller the probability of finding crashing
 174 inputs for individual devices. As such, it is usually a good idea to limit the
 175 fuzzer to only a few ``MemoryRegions``.
 176
 177 To ensure that these env variables have been configured correctly, we can use::
 178
 179     ./qemu-fuzz-i386 --fuzz-target=generic-fuzz -runs=0
 180
 181 The output should contain a complete list of matched MemoryRegions.
 182
 183 OSS-Fuzz
 184 --------
 185 QEMU is continuously fuzzed on `OSS-Fuzz` __(https://github.com/google/oss-fuzz).
 186 By default, the OSS-Fuzz build will try to fuzz every fuzz-target. Since the
 187 generic-fuzz target requires additional information provided in environment
 188 variables, we pre-define some generic-fuzz configs in
 189 ``tests/qtest/fuzz/generic_fuzz_configs.h``. Each config must specify:
 190
 191 - ``.name``: To identify the fuzzer config
 192
 193 - ``.args`` OR ``.argfunc``: A string or pointer to a function returning a
 194   string.  These strings are used to specify the ``QEMU_FUZZ_ARGS``
 195   environment variable.  ``argfunc`` is useful when the config relies on e.g.
 196   a dynamically created temp directory, or a free tcp/udp port.
 197
 198 - ``.objects``: A string that specifies the ``QEMU_FUZZ_OBJECTS`` environment
 199   variable.
 200
 201 To fuzz additional devices/device configuration on OSS-Fuzz, send patches for
 202 either a new device-specific fuzzer or a new generic-fuzz config.
 203
 204 Build details:
 205
 206 - The Dockerfile that sets up the environment for building QEMU's
 207   fuzzers on OSS-Fuzz can be fund in the OSS-Fuzz repository
 208   __(https://github.com/google/oss-fuzz/blob/master/projects/qemu/Dockerfile)
 209
 210 - The script responsible for building the fuzzers can be found in the
 211   QEMU source tree at ``scripts/oss-fuzz/build.sh``
 212
 213 Implementation Details / Fuzzer Lifecycle
 214 -----------------------------------------
 215
 216 The fuzzer has two entrypoints that libfuzzer calls. libfuzzer provides it's
 217 own ``main()``, which performs some setup, and calls the entrypoints:
 218
 219 ``LLVMFuzzerInitialize``: called prior to fuzzing. Used to initialize all of the
 220 necessary state
 221
 222 ``LLVMFuzzerTestOneInput``: called for each fuzzing run. Processes the input and
 223 resets the state at the end of each run.
 224
 225 In more detail:
 226
 227 ``LLVMFuzzerInitialize`` parses the arguments to the fuzzer (must start with two
 228 dashes, so they are ignored by libfuzzer ``main()``). Currently, the arguments
 229 select the fuzz target. Then, the qtest client is initialized. If the target
 230 requires qos, qgraph is set up and the QOM/LIBQOS modules are initialized.
 231 Then the QGraph is walked and the QEMU cmd_line is determined and saved.
 232
 233 After this, the ``vl.c:qemu_main`` is called to set up the guest. There are
 234 target-specific hooks that can be called before and after qemu_main, for
 235 additional setup(e.g. PCI setup, or VM snapshotting).
 236
 237 ``LLVMFuzzerTestOneInput``: Uses qtest/qos functions to act based on the fuzz
 238 input. It is also responsible for manually calling ``main_loop_wait`` to ensure
 239 that bottom halves are executed and any cleanup required before the next input.
 240
 241 Since the same process is reused for many fuzzing runs, QEMU state needs to
 242 be reset at the end of each run. There are currently two implemented
 243 options for resetting state:
 244
 245 - Reboot the guest between runs.
 246   - *Pros*: Straightforward and fast for simple fuzz targets.
 247
 248   - *Cons*: Depending on the device, does not reset all device state. If the
 249     device requires some initialization prior to being ready for fuzzing (common
 250     for QOS-based targets), this initialization needs to be done after each
 251     reboot.
 252
 253   - *Example target*: ``i440fx-qtest-reboot-fuzz``
 254
 255 - Run each test case in a separate forked process and copy the coverage
 256    information back to the parent. This is fairly similar to AFL's "deferred"
 257    fork-server mode [3]
 258
 259   - *Pros*: Relatively fast. Devices only need to be initialized once. No need to
 260     do slow reboots or vmloads.
 261
 262   - *Cons*: Not officially supported by libfuzzer. Does not work well for
 263      devices that rely on dedicated threads.
 264
 265   - *Example target*: ``virtio-net-fork-fuzz``