diff options
| author | Andrey Konovalov <andreyknvl@google.com> | 2017-10-27 15:09:26 +0200 |
|---|---|---|
| committer | Andrey Konovalov <andreyknvl@gmail.com> | 2017-10-27 15:39:00 +0200 |
| commit | 80c748800e07c28955c3cf696e7eda464a3f0634 (patch) | |
| tree | d06149d4d790a3a1a14d8203ade331dcc4540ac8 /docs/setup.md | |
| parent | 06a268ea21e01e94e7b8ab8ee5a64a82165e304b (diff) | |
docs: assorted improvements
Diffstat (limited to 'docs/setup.md')
| -rw-r--r-- | docs/setup.md | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/docs/setup.md b/docs/setup.md index d06887bfa..c071d554d 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,13 +1,7 @@ -# How to install syzkaller +# How to set up syzkaller Generic setup instructions for fuzzing Linux kernel are outlined [here](linux/setup.md). -Instructions for a particular VM or kernel arch can be found on these pages: - -- [Setup: Ubuntu host, QEMU vm, x86-64 kernel](linux/setup_ubuntu-host_qemu-vm_x86-64-kernel.md) -- [Setup: Ubuntu host, Odroid C2 board, arm64 kernel](linux/setup_ubuntu-host_odroid-c2-board_arm64-kernel.md) -- [Setup: Linux host, QEMU vm, arm64 kernel](linux/setup_linux-host_qemu-vm_arm64-kernel.md) -- [Setup: Linux host, Android device, arm64 kernel](linux/setup_linux-host_android-device_arm64-kernel.md) -- [Setup: Linux isolated host](linux/setup_linux-host_isolated.md) +For other OS kernels check: [Akaros](/docs/akaros.md), [FreeBSD](/docs/freebsd.md), [Fuchsia](/docs/fuchsia.md), [NetBSD](/docs/netbsd.md), [Windows](/docs/windows.md). After following these instructions you should be able to run `syz-manager`, see it executing programs and be able to access statistics exposed at `http://127.0.0.1:56741`: @@ -26,6 +20,10 @@ $ ./bin/syz-manager -config=my.cfg 2017/06/14 16:40:35 executed 15504, cover 132403, crashes 0, repro 0 ``` +At this point it's important to ensure that syzkaller is able to collect code coverage of the executed programs +(unless you specified `"cover": false` in the config or coverage is not yet supported for the kernel you're fuzzing). +The `cover` counter on the web page should be non zero. + More information on the configuration file format is available [here](configuration.md). See [this page](troubleshooting.md) for troubleshooting tips. |