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