All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alexander Bulekov <alxndr@bu.edu>
To: qemu-devel@nongnu.org
Cc: Peter Maydell <peter.maydell@linaro.org>,
	Darren Kenny <darren.kenny@oracle.com>,
	Alexander Bulekov <alxndr@bu.edu>
Subject: [PULL 6/7] docs/fuzz: add some information about OSS-Fuzz
Date: Wed, 20 Jan 2021 12:44:55 -0500	[thread overview]
Message-ID: <20210120174456.275312-7-alxndr@bu.edu> (raw)
In-Reply-To: <20210120174456.275312-1-alxndr@bu.edu>

Signed-off-by: Alexander Bulekov <alxndr@bu.edu>
Reviewed-by: Darren Kenny <darren.kenny@oracle.com>
---
 docs/devel/fuzzing.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/devel/fuzzing.rst b/docs/devel/fuzzing.rst
index 5f5200c843..b9bb07988b 100644
--- a/docs/devel/fuzzing.rst
+++ b/docs/devel/fuzzing.rst
@@ -180,6 +180,32 @@ To ensure that these env variables have been configured correctly, we can use::
 
 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 a new device-specific fuzzer
+ * Send patches for a new generic-fuzz config
+
+Build details:
+ * `The basic Dockerfile that sets up the environment for building QEMU's
+   fuzzers on OSS-Fuzz
+   <https://github.com/google/oss-fuzz/blob/master/projects/qemu/Dockerfile>`_
+ * The script responsible for building the fuzzers:
+   ``scripts/oss-fuzz/build.sh``
+
 Implementation Details / Fuzzer Lifecycle
 -----------------------------------------
 
-- 
2.28.0



  parent reply	other threads:[~2021-01-20 18:00 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-20 17:44 [PULL 0/7] 2021-01-20 fuzzing patches Alexander Bulekov
2021-01-20 17:44 ` [PULL 1/7] fuzz: ignore address_space_map is_write flag Alexander Bulekov
2021-01-20 17:44 ` [PULL 2/7] fuzz: refine the ide/ahci fuzzer configs Alexander Bulekov
2021-01-20 17:44 ` [PULL 3/7] docs/fuzz: fix pre-meson path Alexander Bulekov
2021-01-20 17:44 ` [PULL 4/7] fuzz: log the arguments used to initialize QEMU Alexander Bulekov
2021-01-20 17:44 ` [PULL 5/7] fuzz: enable dynamic args for generic-fuzz configs Alexander Bulekov
2021-01-20 17:44 ` Alexander Bulekov [this message]
2021-01-20 17:44 ` [PULL 7/7] fuzz: add virtio-9p configurations for fuzzing Alexander Bulekov
2021-01-22 15:06 ` [PULL 0/7] 2021-01-20 fuzzing patches Peter Maydell
2021-01-25 19:09   ` Alexander Bulekov
  -- strict thread matches above, loose matches on Subject: below --
2021-01-20 17:35 Alexander Bulekov
2021-01-20 17:35 ` [PULL 6/7] docs/fuzz: add some information about OSS-Fuzz Alexander Bulekov

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=20210120174456.275312-7-alxndr@bu.edu \
    --to=alxndr@bu.edu \
    --cc=darren.kenny@oracle.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.