diff options
| author | Dmitry Vyukov <dvyukov@google.com> | 2018-06-25 11:58:28 +0200 |
|---|---|---|
| committer | Dmitry Vyukov <dvyukov@google.com> | 2018-06-25 11:58:28 +0200 |
| commit | 5e7849c5d16ce9e941cb8ecadcabed7fc43566ce (patch) | |
| tree | cdd3d9cc5c133d76dfdb49da96d76479876ec973 | |
| parent | 2064fc5c9114c170841328aaa4b124a4062becf6 (diff) | |
docs: add gvisor page
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | docs/gvisor.md | 26 |
2 files changed, 28 insertions, 2 deletions
@@ -2,7 +2,7 @@ [](https://travis-ci.org/google/syzkaller) -`syzkaller` is an unsupervised coverage-guided kernel fuzzer. `Linux` kernel fuzzing has the most support, `akaros`, `freebsd`, `fuchsia`, `netbsd` and `windows` are supported to varying degrees. +`syzkaller` is an unsupervised coverage-guided kernel fuzzer. `Linux` kernel fuzzing has the most support, `akaros`, `freebsd`, `fuchsia`, `netbsd`, `windows` and `gvisor` are supported to varying degrees. The project mailing list is [syzkaller@googlegroups.com](https://groups.google.com/forum/#!forum/syzkaller). You can subscribe to it with a google account or by sending an email to syzkaller+subscribe@googlegroups.com. @@ -13,7 +13,7 @@ You can subscribe to it with a google account or by sending an email to syzkalle Initially, syzkaller was developed with Linux kernel fuzzing in mind, but now it's being extended to support other OS kernels as well. Most of the documentation at this moment is related to the Linux kernel. -For other OS kernels check: [Akaros](docs/akaros/README.md), [FreeBSD](docs/freebsd.md), [Fuchsia](docs/fuchsia.md), [NetBSD](docs/netbsd.md), [Windows](docs/windows.md). +For other OS kernels check: [Akaros](docs/akaros/README.md), [FreeBSD](docs/freebsd.md), [Fuchsia](docs/fuchsia.md), [NetBSD](docs/netbsd.md), [Windows](docs/windows.md), [gVisor](docs/gvisor.md). - [How to install syzkaller](docs/setup.md) - [How to use syzkaller](docs/usage.md) diff --git a/docs/gvisor.md b/docs/gvisor.md new file mode 100644 index 000000000..be399b107 --- /dev/null +++ b/docs/gvisor.md @@ -0,0 +1,26 @@ +# gVisor + +[gVisor](https://github.com/google/gvisor) is a user-space kernel, written in +Go, that implements a substantial portion of the Linux system surface. + +`gVisor` uses `linux` OS, but the special `gvisor` VM type. There is nothing +special regarding `gVisor` besides that. Here is an example manager config: + +``` +{ + "name": "gvisor", + "target": "linux/amd64", + "http": ":12345", + "workdir": "/workdir", + "image": "/usr/local/bin/runsc", + "vmlinux": "/usr/local/bin/runsc", + "syzkaller": "/gopath/src/github.com/google/syzkaller", + "cover": false, + "procs": 8, + "type": "gvisor", + "vm": { + "count": 5, + "runsc_args": "-platform=kvm" + } +} +``` |