aboutsummaryrefslogtreecommitdiffstats
path: root/docs/syzbot.md
diff options
context:
space:
mode:
authorDmitry Vyukov <dvyukov@google.com>2017-10-24 13:30:53 +0200
committerGitHub <noreply@github.com>2017-10-24 13:30:53 +0200
commit01191dcf5dc8eaac07004bdb0773c91455c4ac08 (patch)
tree24ac68bc7e7e5e5a5920b42e70753c6fa5a4994c /docs/syzbot.md
parent7a28007ebeae770e028d18cdef6e2b748389505a (diff)
Update syzbot.md
Diffstat (limited to 'docs/syzbot.md')
-rw-r--r--docs/syzbot.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/syzbot.md b/docs/syzbot.md
index b86e40a9e..a134eb1d6 100644
--- a/docs/syzbot.md
+++ b/docs/syzbot.md
@@ -3,6 +3,38 @@
`syzbot` system continuously fuzzes main Linux kernel branches and automatically
reports all found bugs. Direct all questions to syzkaller@googlegroups.com.
+## Bug status tracking
+
+`syzbot` needs to know when a bug is fixed in order to (1) verify that it is
+in fact fixed and (2) be able to report other similarly-looking crashes
+(while a bug is considered open all similarly-looking crashes are merged into
+the existing bug). To understand when a bug is fixed `syzbot` needs to know
+what commit fixes the bug; once `syzbot` knows the commit it will track when
+the commit reaches all kernel builds on all tracked branches. Only when the
+commit reaches all builds, the bug is considered closed (new similarly-looking
+crashes create a new bug).
+
+## Communication with syzbot
+
+You can communicate with `syzbot` by replying to its emails.
+The commands are:
+
+- to attach a fixing commit to the bug:
+```
+#syz fix: exact-commit-title
+````
+- to mark the bug as a duplicate of another `syzbot` bug:
+```
+#syz dup: exact-subject-of-another-report
+```
+- to mark the bug as a one-off invalid report (e.g. induced by a previous memory corruption):
+```
+#syz invalid
+```
+Note: if the crash happens again, it will cause creation of a new bug report.
+
+Note: all commands must start from beginning of the line.
+
## syzkaller reproducers
`syzbot` aims at providing stand-alone C reproducers for all reported bugs.
@@ -36,3 +68,7 @@ very hard to reproduce in general; some crashes are caused by global accumulated
state in kernel (e.g. lockdep reports); some crashes are caused by
non-reproducible coincidences (e.g. an integer `0x12345` happened to reference an
existing IPC object) and there is long tail of other reasons.
+
+## Is syzbot code available?
+
+Yes, it is [here](https://github.com/google/syzkaller/tree/master/dashboard/app).