1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * tools/testing/selftests/kvm/include/test_util.h
4  *
5  * Copyright (C) 2018, Google LLC.
6  */
7 
8 #ifndef SELFTEST_KVM_TEST_UTIL_H
9 #define SELFTEST_KVM_TEST_UTIL_H
10 
11 #include <stdlib.h>
12 #include <stdarg.h>
13 #include <stdbool.h>
14 #include <stdio.h>
15 #include <string.h>
16 #include <inttypes.h>
17 #include <errno.h>
18 #include <unistd.h>
19 #include <fcntl.h>
20 #include <sys/mman.h>
21 #include "kselftest.h"
22 
23 static inline int _no_printf(const char *format, ...) { return 0; }
24 
25 #ifdef DEBUG
26 #define pr_debug(...) printf(__VA_ARGS__)
27 #else
28 #define pr_debug(...) _no_printf(__VA_ARGS__)
29 #endif
30 #ifndef QUIET
31 #define pr_info(...) printf(__VA_ARGS__)
32 #else
33 #define pr_info(...) _no_printf(__VA_ARGS__)
34 #endif
35 
36 void print_skip(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
37 #define __TEST_REQUIRE(f, fmt, ...)				\
38 do {								\
39 	if (!(f))						\
40 		ksft_exit_skip("- " fmt "\n", ##__VA_ARGS__);	\
41 } while (0)
42 
43 #define TEST_REQUIRE(f) __TEST_REQUIRE(f, "Requirement not met: %s", #f)
44 
45 ssize_t test_write(int fd, const void *buf, size_t count);
46 ssize_t test_read(int fd, void *buf, size_t count);
47 int test_seq_read(const char *path, char **bufp, size_t *sizep);
48 
49 void test_assert(bool exp, const char *exp_str,
50 		 const char *file, unsigned int line, const char *fmt, ...)
51 		__attribute__((format(printf, 5, 6)));
52 
53 #define TEST_ASSERT(e, fmt, ...) \
54 	test_assert((e), #e, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
55 
56 #define TEST_ASSERT_EQ(a, b)						\
57 do {									\
58 	typeof(a) __a = (a);						\
59 	typeof(b) __b = (b);						\
60 	test_assert(__a == __b, #a " == " #b, __FILE__, __LINE__,	\
61 		    "%#lx != %#lx (%s != %s)",				\
62 		    (unsigned long)(__a), (unsigned long)(__b), #a, #b);\
63 } while (0)
64 
65 #define TEST_ASSERT_KVM_EXIT_REASON(vcpu, expected) do {		\
66 	__u32 exit_reason = (vcpu)->run->exit_reason;			\
67 									\
68 	TEST_ASSERT(exit_reason == (expected),				\
69 		    "Wanted KVM exit reason: %u (%s), got: %u (%s)",    \
70 		    (expected), exit_reason_str((expected)),		\
71 		    exit_reason, exit_reason_str(exit_reason));		\
72 } while (0)
73 
74 #define TEST_FAIL(fmt, ...) do { \
75 	TEST_ASSERT(false, fmt, ##__VA_ARGS__); \
76 	__builtin_unreachable(); \
77 } while (0)
78 
79 size_t parse_size(const char *size);
80 
81 int64_t timespec_to_ns(struct timespec ts);
82 struct timespec timespec_add_ns(struct timespec ts, int64_t ns);
83 struct timespec timespec_add(struct timespec ts1, struct timespec ts2);
84 struct timespec timespec_sub(struct timespec ts1, struct timespec ts2);
85 struct timespec timespec_elapsed(struct timespec start);
86 struct timespec timespec_div(struct timespec ts, int divisor);
87 
88 struct guest_random_state {
89 	uint32_t seed;
90 };
91 
92 struct guest_random_state new_guest_random_state(uint32_t seed);
93 uint32_t guest_random_u32(struct guest_random_state *state);
94 
95 enum vm_mem_backing_src_type {
96 	VM_MEM_SRC_ANONYMOUS,
97 	VM_MEM_SRC_ANONYMOUS_THP,
98 	VM_MEM_SRC_ANONYMOUS_HUGETLB,
99 	VM_MEM_SRC_ANONYMOUS_HUGETLB_16KB,
100 	VM_MEM_SRC_ANONYMOUS_HUGETLB_64KB,
101 	VM_MEM_SRC_ANONYMOUS_HUGETLB_512KB,
102 	VM_MEM_SRC_ANONYMOUS_HUGETLB_1MB,
103 	VM_MEM_SRC_ANONYMOUS_HUGETLB_2MB,
104 	VM_MEM_SRC_ANONYMOUS_HUGETLB_8MB,
105 	VM_MEM_SRC_ANONYMOUS_HUGETLB_16MB,
106 	VM_MEM_SRC_ANONYMOUS_HUGETLB_32MB,
107 	VM_MEM_SRC_ANONYMOUS_HUGETLB_256MB,
108 	VM_MEM_SRC_ANONYMOUS_HUGETLB_512MB,
109 	VM_MEM_SRC_ANONYMOUS_HUGETLB_1GB,
110 	VM_MEM_SRC_ANONYMOUS_HUGETLB_2GB,
111 	VM_MEM_SRC_ANONYMOUS_HUGETLB_16GB,
112 	VM_MEM_SRC_SHMEM,
113 	VM_MEM_SRC_SHARED_HUGETLB,
114 	NUM_SRC_TYPES,
115 };
116 
117 #define DEFAULT_VM_MEM_SRC VM_MEM_SRC_ANONYMOUS
118 
119 struct vm_mem_backing_src_alias {
120 	const char *name;
121 	uint32_t flag;
122 };
123 
124 #define MIN_RUN_DELAY_NS	200000UL
125 
126 bool thp_configured(void);
127 size_t get_trans_hugepagesz(void);
128 size_t get_def_hugetlb_pagesz(void);
129 const struct vm_mem_backing_src_alias *vm_mem_backing_src_alias(uint32_t i);
130 size_t get_backing_src_pagesz(uint32_t i);
131 bool is_backing_src_hugetlb(uint32_t i);
132 void backing_src_help(const char *flag);
133 enum vm_mem_backing_src_type parse_backing_src_type(const char *type_name);
134 long get_run_delay(void);
135 
136 /*
137  * Whether or not the given source type is shared memory (as opposed to
138  * anonymous).
139  */
140 static inline bool backing_src_is_shared(enum vm_mem_backing_src_type t)
141 {
142 	return vm_mem_backing_src_alias(t)->flag & MAP_SHARED;
143 }
144 
145 /* Aligns x up to the next multiple of size. Size must be a power of 2. */
146 static inline uint64_t align_up(uint64_t x, uint64_t size)
147 {
148 	uint64_t mask = size - 1;
149 
150 	TEST_ASSERT(size != 0 && !(size & (size - 1)),
151 		    "size not a power of 2: %lu", size);
152 	return ((x + mask) & ~mask);
153 }
154 
155 static inline uint64_t align_down(uint64_t x, uint64_t size)
156 {
157 	uint64_t x_aligned_up = align_up(x, size);
158 
159 	if (x == x_aligned_up)
160 		return x;
161 	else
162 		return x_aligned_up - size;
163 }
164 
165 static inline void *align_ptr_up(void *x, size_t size)
166 {
167 	return (void *)align_up((unsigned long)x, size);
168 }
169 
170 int atoi_paranoid(const char *num_str);
171 
172 static inline uint32_t atoi_positive(const char *name, const char *num_str)
173 {
174 	int num = atoi_paranoid(num_str);
175 
176 	TEST_ASSERT(num > 0, "%s must be greater than 0, got '%s'", name, num_str);
177 	return num;
178 }
179 
180 static inline uint32_t atoi_non_negative(const char *name, const char *num_str)
181 {
182 	int num = atoi_paranoid(num_str);
183 
184 	TEST_ASSERT(num >= 0, "%s must be non-negative, got '%s'", name, num_str);
185 	return num;
186 }
187 
188 int guest_vsnprintf(char *buf, int n, const char *fmt, va_list args);
189 int guest_snprintf(char *buf, int n, const char *fmt, ...);
190 
191 char *strdup_printf(const char *fmt, ...) __attribute__((format(printf, 1, 2), nonnull(1)));
192 
193 #endif /* SELFTEST_KVM_TEST_UTIL_H */
194