xref: /freebsd/sys/sys/coverage.h (revision 524553f56d0b89c689754f1e0a51205bbbcf5071)
1*524553f5SAndrew Turner /*-
2*524553f5SAndrew Turner  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3*524553f5SAndrew Turner  *
4*524553f5SAndrew Turner  * Copyright (C) 2018 The FreeBSD Foundation. All rights reserved.
5*524553f5SAndrew Turner  * Copyright (C) 2018, 2019 Andrew Turner.
6*524553f5SAndrew Turner  *
7*524553f5SAndrew Turner  * This software was developed by Mitchell Horne under sponsorship of
8*524553f5SAndrew Turner  * the FreeBSD Foundation.
9*524553f5SAndrew Turner  *
10*524553f5SAndrew Turner  * This software was developed by SRI International and the University of
11*524553f5SAndrew Turner  * Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
12*524553f5SAndrew Turner  * ("CTSRD"), as part of the DARPA CRASH research programme.
13*524553f5SAndrew Turner  *
14*524553f5SAndrew Turner  * Redistribution and use in source and binary forms, with or without
15*524553f5SAndrew Turner  * modification, are permitted provided that the following conditions
16*524553f5SAndrew Turner  * are met:
17*524553f5SAndrew Turner  * 1. Redistributions of source code must retain the above copyright
18*524553f5SAndrew Turner  *    notice, this list of conditions and the following disclaimer.
19*524553f5SAndrew Turner  * 2. Redistributions in binary form must reproduce the above copyright
20*524553f5SAndrew Turner  *    notice, this list of conditions and the following disclaimer in the
21*524553f5SAndrew Turner  *    documentation and/or other materials provided with the distribution.
22*524553f5SAndrew Turner  *
23*524553f5SAndrew Turner  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24*524553f5SAndrew Turner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25*524553f5SAndrew Turner  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26*524553f5SAndrew Turner  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27*524553f5SAndrew Turner  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28*524553f5SAndrew Turner  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29*524553f5SAndrew Turner  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30*524553f5SAndrew Turner  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31*524553f5SAndrew Turner  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32*524553f5SAndrew Turner  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33*524553f5SAndrew Turner  * SUCH DAMAGE.
34*524553f5SAndrew Turner  *
35*524553f5SAndrew Turner  * $FreeBSD$
36*524553f5SAndrew Turner  */
37*524553f5SAndrew Turner 
38*524553f5SAndrew Turner #ifndef _SYS_COVERAGE_H_
39*524553f5SAndrew Turner #define _SYS_COVERAGE_H_
40*524553f5SAndrew Turner 
41*524553f5SAndrew Turner #if !defined(_KERNEL) && !defined(_SYS_KCOV_H_)
42*524553f5SAndrew Turner #error Do not include this file directly in userspace, use sys/kcov.h
43*524553f5SAndrew Turner #endif
44*524553f5SAndrew Turner 
45*524553f5SAndrew Turner #define	COV_CMP_CONST		(1 << 0)
46*524553f5SAndrew Turner #define	COV_CMP_SIZE(x)		((x) << 1)
47*524553f5SAndrew Turner #define	COV_CMP_MASK		(3 << 1)
48*524553f5SAndrew Turner #define	COV_CMP_GET_SIZE(x)	(((x) >> 1) & 3)
49*524553f5SAndrew Turner 
50*524553f5SAndrew Turner #ifdef _KERNEL
51*524553f5SAndrew Turner typedef void (*cov_trace_pc_t)(uintptr_t);
52*524553f5SAndrew Turner typedef bool (*cov_trace_cmp_t)(uint64_t, uint64_t, uint64_t, uint64_t);
53*524553f5SAndrew Turner 
54*524553f5SAndrew Turner void cov_register_cmp(cov_trace_cmp_t);
55*524553f5SAndrew Turner void cov_unregister_cmp(void);
56*524553f5SAndrew Turner void cov_register_pc(cov_trace_pc_t);
57*524553f5SAndrew Turner void cov_unregister_pc(void);
58*524553f5SAndrew Turner #endif
59*524553f5SAndrew Turner 
60*524553f5SAndrew Turner #endif /* _SYS_COVERAGE_H_ */
61