1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2*4882a593Smuzhiyun #ifndef _LINUX_KCOV_IOCTLS_H
3*4882a593Smuzhiyun #define _LINUX_KCOV_IOCTLS_H
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun #include <linux/types.h>
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun /*
8*4882a593Smuzhiyun * Argument for KCOV_REMOTE_ENABLE ioctl, see Documentation/dev-tools/kcov.rst
9*4882a593Smuzhiyun * and the comment before kcov_remote_start() for usage details.
10*4882a593Smuzhiyun */
11*4882a593Smuzhiyun struct kcov_remote_arg {
12*4882a593Smuzhiyun __u32 trace_mode; /* KCOV_TRACE_PC or KCOV_TRACE_CMP */
13*4882a593Smuzhiyun __u32 area_size; /* Length of coverage buffer in words */
14*4882a593Smuzhiyun __u32 num_handles; /* Size of handles array */
15*4882a593Smuzhiyun __aligned_u64 common_handle;
16*4882a593Smuzhiyun __aligned_u64 handles[0];
17*4882a593Smuzhiyun };
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun #define KCOV_REMOTE_MAX_HANDLES 0x100
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun #define KCOV_INIT_TRACE _IOR('c', 1, unsigned long)
22*4882a593Smuzhiyun #define KCOV_ENABLE _IO('c', 100)
23*4882a593Smuzhiyun #define KCOV_DISABLE _IO('c', 101)
24*4882a593Smuzhiyun #define KCOV_REMOTE_ENABLE _IOW('c', 102, struct kcov_remote_arg)
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun enum {
27*4882a593Smuzhiyun /*
28*4882a593Smuzhiyun * Tracing coverage collection mode.
29*4882a593Smuzhiyun * Covered PCs are collected in a per-task buffer.
30*4882a593Smuzhiyun * In new KCOV version the mode is chosen by calling
31*4882a593Smuzhiyun * ioctl(fd, KCOV_ENABLE, mode). In older versions the mode argument
32*4882a593Smuzhiyun * was supposed to be 0 in such a call. So, for reasons of backward
33*4882a593Smuzhiyun * compatibility, we have chosen the value KCOV_TRACE_PC to be 0.
34*4882a593Smuzhiyun */
35*4882a593Smuzhiyun KCOV_TRACE_PC = 0,
36*4882a593Smuzhiyun /* Collecting comparison operands mode. */
37*4882a593Smuzhiyun KCOV_TRACE_CMP = 1,
38*4882a593Smuzhiyun };
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun /*
41*4882a593Smuzhiyun * The format for the types of collected comparisons.
42*4882a593Smuzhiyun *
43*4882a593Smuzhiyun * Bit 0 shows whether one of the arguments is a compile-time constant.
44*4882a593Smuzhiyun * Bits 1 & 2 contain log2 of the argument size, up to 8 bytes.
45*4882a593Smuzhiyun */
46*4882a593Smuzhiyun #define KCOV_CMP_CONST (1 << 0)
47*4882a593Smuzhiyun #define KCOV_CMP_SIZE(n) ((n) << 1)
48*4882a593Smuzhiyun #define KCOV_CMP_MASK KCOV_CMP_SIZE(3)
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun #define KCOV_SUBSYSTEM_COMMON (0x00ull << 56)
51*4882a593Smuzhiyun #define KCOV_SUBSYSTEM_USB (0x01ull << 56)
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun #define KCOV_SUBSYSTEM_MASK (0xffull << 56)
54*4882a593Smuzhiyun #define KCOV_INSTANCE_MASK (0xffffffffull)
55*4882a593Smuzhiyun
kcov_remote_handle(__u64 subsys,__u64 inst)56*4882a593Smuzhiyun static inline __u64 kcov_remote_handle(__u64 subsys, __u64 inst)
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun if (subsys & ~KCOV_SUBSYSTEM_MASK || inst & ~KCOV_INSTANCE_MASK)
59*4882a593Smuzhiyun return 0;
60*4882a593Smuzhiyun return subsys | inst;
61*4882a593Smuzhiyun }
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun #endif /* _LINUX_KCOV_IOCTLS_H */
64