2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2018, 2019 Andrew Turner
6 * This software was developed by SRI International and the University of
7 * Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
8 * ("CTSRD"), as part of the DARPA CRASH research programme.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/ioctl.h>
40 #include <machine/atomic.h>
44 #include <semaphore.h>
48 static const char *modes[] = {
58 fd = open("/dev/kcov", O_RDWR);
60 atf_tc_skip("Failed to open /dev/kcov");
65 ATF_TC_WITHOUT_HEAD(kcov_bufsize);
66 ATF_TC_BODY(kcov_bufsize, tc)
72 ATF_CHECK(ioctl(fd, KIOSETBUFSIZE, 0) == -1);
73 ATF_CHECK(ioctl(fd, KIOSETBUFSIZE, 1) == -1);
74 ATF_CHECK(ioctl(fd, KIOSETBUFSIZE, 2) == 0);
75 ATF_CHECK(ioctl(fd, KIOSETBUFSIZE, 2) == -1);
80 ATF_TC_WITHOUT_HEAD(kcov_mmap);
81 ATF_TC_BODY(kcov_mmap, tc)
88 ATF_CHECK(mmap(NULL, PAGE_SIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
89 fd, 0) == MAP_FAILED);
91 ATF_REQUIRE(ioctl(fd, KIOSETBUFSIZE,
92 2 * PAGE_SIZE / KCOV_ENTRY_SIZE) == 0);
94 ATF_CHECK(mmap(NULL, PAGE_SIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
95 fd, 0) == MAP_FAILED);
96 ATF_CHECK(mmap(NULL, 3 * PAGE_SIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
97 fd, 0) == MAP_FAILED);
98 ATF_REQUIRE((data1 = mmap(NULL, 2 * PAGE_SIZE, PROT_READ | PROT_WRITE,
99 MAP_SHARED, fd, 0)) != MAP_FAILED);
100 ATF_REQUIRE((data2 = mmap(NULL, 2 * PAGE_SIZE, PROT_READ | PROT_WRITE,
101 MAP_SHARED, fd, 0)) != MAP_FAILED);
103 *(uint64_t *)data1 = 0x123456789abcdeful;
104 ATF_REQUIRE(*(uint64_t *)data2 == 0x123456789abcdefull);
105 *(uint64_t *)data2 = 0xfedcba9876543210ul;
106 ATF_REQUIRE(*(uint64_t *)data1 == 0xfedcba9876543210ull);
108 munmap(data1, 2 * PAGE_SIZE);
109 munmap(data2, 2 * PAGE_SIZE);
114 /* This shouldn't panic */
115 ATF_TC_WITHOUT_HEAD(kcov_mmap_no_munmap);
116 ATF_TC_BODY(kcov_mmap_no_munmap, tc)
122 ATF_REQUIRE(ioctl(fd, KIOSETBUFSIZE, PAGE_SIZE / KCOV_ENTRY_SIZE) == 0);
124 ATF_CHECK(mmap(NULL, PAGE_SIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
125 fd, 0) != MAP_FAILED);
130 ATF_TC_WITHOUT_HEAD(kcov_mmap_no_munmap_no_close);
131 ATF_TC_BODY(kcov_mmap_no_munmap_no_close, tc)
137 ATF_REQUIRE(ioctl(fd, KIOSETBUFSIZE, PAGE_SIZE / KCOV_ENTRY_SIZE) == 0);
139 ATF_CHECK(mmap(NULL, PAGE_SIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
140 fd, 0) != MAP_FAILED);
143 static sem_t sem1, sem2;
146 kcov_mmap_enable_thread(void *data)
153 ATF_REQUIRE(ioctl(fd, KIOSETBUFSIZE, PAGE_SIZE / KCOV_ENTRY_SIZE) == 0);
154 ATF_CHECK(mmap(NULL, PAGE_SIZE, PROT_READ | PROT_WRITE, MAP_SHARED,
155 fd, 0) != MAP_FAILED);
156 ATF_CHECK(ioctl(fd, KIOENABLE, KCOV_MODE_TRACE_PC) == 0);
164 ATF_TC_WITHOUT_HEAD(kcov_mmap_enable_thread_close);
165 ATF_TC_BODY(kcov_mmap_enable_thread_close, tc)
170 sem_init(&sem1, 0, 0);
171 sem_init(&sem2, 0, 0);
172 pthread_create(&thread, NULL,
173 kcov_mmap_enable_thread, &fd);
177 pthread_join(thread, NULL);
180 ATF_TC_WITHOUT_HEAD(kcov_enable);
181 ATF_TC_BODY(kcov_enable, tc)
187 ATF_CHECK(ioctl(fd, KIOENABLE, KCOV_MODE_TRACE_PC) == -1);
189 ATF_REQUIRE(ioctl(fd, KIOSETBUFSIZE, PAGE_SIZE / KCOV_ENTRY_SIZE) == 0);
191 /* We need to enable before disable */
192 ATF_CHECK(ioctl(fd, KIODISABLE, 0) == -1);
194 /* Check enabling works only with a valid trace method */
195 ATF_CHECK(ioctl(fd, KIOENABLE, -1) == -1);
196 ATF_CHECK(ioctl(fd, KIOENABLE, KCOV_MODE_TRACE_PC) == 0);
197 ATF_CHECK(ioctl(fd, KIOENABLE, KCOV_MODE_TRACE_PC) == -1);
198 ATF_CHECK(ioctl(fd, KIOENABLE, KCOV_MODE_TRACE_CMP) == -1);
200 /* Disable should only be called once */
201 ATF_CHECK(ioctl(fd, KIODISABLE, 0) == 0);
202 ATF_CHECK(ioctl(fd, KIODISABLE, 0) == -1);
204 /* Re-enabling should also work */
205 ATF_CHECK(ioctl(fd, KIOENABLE, KCOV_MODE_TRACE_CMP) == 0);
206 ATF_CHECK(ioctl(fd, KIODISABLE, 0) == 0);
211 ATF_TC_WITHOUT_HEAD(kcov_enable_no_disable);
212 ATF_TC_BODY(kcov_enable_no_disable, tc)
217 ATF_REQUIRE(ioctl(fd, KIOSETBUFSIZE, PAGE_SIZE / KCOV_ENTRY_SIZE) == 0);
218 ATF_CHECK(ioctl(fd, KIOENABLE, KCOV_MODE_TRACE_PC) == 0);
222 ATF_TC_WITHOUT_HEAD(kcov_enable_no_disable_no_close);
223 ATF_TC_BODY(kcov_enable_no_disable_no_close, tc)
228 ATF_REQUIRE(ioctl(fd, KIOSETBUFSIZE, PAGE_SIZE / KCOV_ENTRY_SIZE) == 0);
229 ATF_CHECK(ioctl(fd, KIOENABLE, KCOV_MODE_TRACE_PC) == 0);
233 common_head(int *fdp)
240 ATF_REQUIRE_MSG(ioctl(fd, KIOSETBUFSIZE,
241 PAGE_SIZE / KCOV_ENTRY_SIZE) == 0,
242 "Unable to set the kcov buffer size");
244 data = mmap(NULL, PAGE_SIZE, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
245 ATF_REQUIRE_MSG(data != MAP_FAILED, "Unable to mmap the kcov buffer");
252 common_tail(int fd, void *data)
255 ATF_REQUIRE_MSG(munmap(data, PAGE_SIZE) == 0,
256 "Unable to unmap the kcov buffer");
262 basic_test(u_int mode)
267 buf = common_head(&fd);
268 ATF_REQUIRE_MSG(ioctl(fd, KIOENABLE, mode) == 0,
269 "Unable to enable kcov %s",
270 mode < nitems(modes) ? modes[mode] : "unknown mode");
272 atomic_store_64(&buf[0], 0);
275 ATF_REQUIRE_MSG(atomic_load_64(&buf[0]) != 0, "No records found");
277 ATF_REQUIRE_MSG(ioctl(fd, KIODISABLE, 0) == 0,
278 "Unable to disable kcov");
280 common_tail(fd, buf);
283 ATF_TC_WITHOUT_HEAD(kcov_basic_pc);
284 ATF_TC_BODY(kcov_basic_pc, tc)
286 basic_test(KCOV_MODE_TRACE_PC);
289 ATF_TC_WITHOUT_HEAD(kcov_basic_cmp);
290 ATF_TC_BODY(kcov_basic_cmp, tc)
292 basic_test(KCOV_MODE_TRACE_CMP);
296 thread_test_helper(void *ptr)
300 atomic_store_64(&buf[0], 0);
302 ATF_REQUIRE_MSG(atomic_load_64(&buf[0]) == 0,
303 "Records changed in blocked thread");
309 thread_test(u_int mode)
315 buf = common_head(&fd);
317 ATF_REQUIRE_MSG(ioctl(fd, KIOENABLE, mode) == 0,
318 "Unable to enable kcov %s",
319 mode < nitems(modes) ? modes[mode] : "unknown mode");
321 pthread_create(&thread, NULL, thread_test_helper, buf);
322 pthread_join(thread, NULL);
324 ATF_REQUIRE_MSG(ioctl(fd, KIODISABLE, 0) == 0,
325 "Unable to disable kcov");
327 common_tail(fd, buf);
330 ATF_TC_WITHOUT_HEAD(kcov_thread_pc);
331 ATF_TC_BODY(kcov_thread_pc, tc)
333 thread_test(KCOV_MODE_TRACE_PC);
336 ATF_TC_WITHOUT_HEAD(kcov_thread_cmp);
337 ATF_TC_BODY(kcov_thread_cmp, tc)
339 thread_test(KCOV_MODE_TRACE_CMP);
342 struct multi_thread_data {
350 multi_thread_test_helper(void *ptr)
352 struct multi_thread_data *data = ptr;
354 ATF_REQUIRE_MSG(ioctl(data->fd, KIOENABLE, data->mode) == 0,
355 "Unable to enable kcov %s in thread %d",
356 data->mode < nitems(modes) ? modes[data->mode] : "unknown mode",
359 atomic_store_64(&data->buf[0], 0);
361 ATF_REQUIRE_MSG(atomic_load_64(&data->buf[0]) != 0,
362 "No records found in thread %d", data->thread);
367 ATF_TC_WITHOUT_HEAD(kcov_enable_multi_thread);
368 ATF_TC_BODY(kcov_enable_multi_thread, t)
370 struct multi_thread_data data;
373 data.buf = common_head(&data.fd);
375 /* Run the thread to completion */
377 data.mode = KCOV_MODE_TRACE_PC;
378 pthread_create(&thread, NULL, multi_thread_test_helper, &data);
379 pthread_join(thread, NULL);
381 /* Run it again to check enable works on the same fd */
383 data.mode = KCOV_MODE_TRACE_CMP;
384 pthread_create(&thread, NULL, multi_thread_test_helper, &data);
385 pthread_join(thread, NULL);
387 common_tail(data.fd, data.buf);
393 ATF_TP_ADD_TC(tp, kcov_bufsize);
394 ATF_TP_ADD_TC(tp, kcov_mmap);
395 ATF_TP_ADD_TC(tp, kcov_mmap_no_munmap);
396 ATF_TP_ADD_TC(tp, kcov_mmap_no_munmap_no_close);
397 ATF_TP_ADD_TC(tp, kcov_enable);
398 ATF_TP_ADD_TC(tp, kcov_enable_no_disable);
399 ATF_TP_ADD_TC(tp, kcov_enable_no_disable_no_close);
400 ATF_TP_ADD_TC(tp, kcov_mmap_enable_thread_close);
401 ATF_TP_ADD_TC(tp, kcov_basic_pc);
402 ATF_TP_ADD_TC(tp, kcov_basic_cmp);
403 ATF_TP_ADD_TC(tp, kcov_thread_pc);
404 ATF_TP_ADD_TC(tp, kcov_thread_cmp);
405 ATF_TP_ADD_TC(tp, kcov_enable_multi_thread);
406 return (atf_no_error());