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