path: root/sys/sys/proc.h
diff options
authorAndrew Turner <andrew@FreeBSD.org>2019-01-12 11:21:28 +0000
committerAndrew Turner <andrew@FreeBSD.org>2019-01-12 11:21:28 +0000
commitb3c0d957a2e716b4d8180ada511f54ee673a9e1e (patch)
treeab6ecc7fe9f9646158c4cf61dcde4d666bfe8f08 /sys/sys/proc.h
parentf4dbf0d82d9b5a2135689a1b1e6c594428ebba3d (diff)
Add support for the Clang Coverage Sanitizer in the kernel (KCOV).
When building with KCOV enabled the compiler will insert function calls to probes allowing us to trace the execution of the kernel from userspace. These probes are on function entry (trace-pc) and on comparison operations (trace-cmp). Userspace can enable the use of these probes on a single kernel thread with an ioctl interface. It can allocate space for the probe with KIOSETBUFSIZE, then mmap the allocated buffer and enable tracing with KIOENABLE, with the trace mode being passed in as the int argument. When complete KIODISABLE is used to disable tracing. The first item in the buffer is the number of trace event that have happened. Userspace can write 0 to this to reset the tracing, and is expected to do so on first use. The format of the buffer depends on the trace mode. When in PC tracing just the return address of the probe is stored. Under comparison tracing the comparison type, the two arguments, and the return address are traced. The former method uses on entry per trace event, while the later uses 4. As such they are incompatible so only a single mode may be enabled. KCOV is expected to help fuzzing the kernel, and while in development has already found a number of issues. It is required for the syzkaller system call fuzzer [1]. Other kernel fuzzers could also make use of it, either with the current interface, or by extending it with new modes. A man page is currently being worked on and is expected to be committed soon, however having the code in the kernel now is useful for other developers to use. [1] https://github.com/google/syzkaller Submitted by: Mitchell Horne <mhorne063@gmail.com> (Earlier version) Reviewed by: kib Testing by: tuexen Sponsored by: DARPA, AFRL Sponsored by: The FreeBSD Foundation (Mitchell Horne) Differential Revision: https://reviews.freebsd.org/D14599
Notes: svn path=/head/; revision=342962
Diffstat (limited to 'sys/sys/proc.h')
1 files changed, 2 insertions, 0 deletions
diff --git a/sys/sys/proc.h b/sys/sys/proc.h
index 122edd08b503..21b8a710701c 100644
--- a/sys/sys/proc.h
+++ b/sys/sys/proc.h
@@ -175,6 +175,7 @@ struct filecaps;
struct filemon;
struct kaioinfo;
struct kaudit_record;
+struct kcov_info;
struct kdtrace_proc;
struct kdtrace_thread;
struct mqueue_notifier;
@@ -300,6 +301,7 @@ struct thread {
sbintime_t td_sleeptimo; /* (t) Sleep timeout. */
int td_rtcgen; /* (s) rtc_generation of abs. sleep */
size_t td_vslock_sz; /* (k) amount of vslock-ed space */
+ struct kcov_info *td_kcov_info; /* (*) Kernel code coverage data */
#define td_endzero td_sigmask
/* Copied during fork1() or create_thread(). */