Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
23static 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
36void print_skip(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
37#define __TEST_REQUIRE(f, fmt, ...) \
38do { \
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
45ssize_t test_write(int fd, const void *buf, size_t count);
46ssize_t test_read(int fd, void *buf, size_t count);
47int test_seq_read(const char *path, char **bufp, size_t *sizep);
48
49void 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 ASSERT_EQ(a, b) do { \
57 typeof(a) __a = (a); \
58 typeof(b) __b = (b); \
59 TEST_ASSERT(__a == __b, \
60 "ASSERT_EQ(%s, %s) failed.\n" \
61 "\t%s is %#lx\n" \
62 "\t%s is %#lx", \
63 #a, #b, #a, (unsigned long) __a, #b, (unsigned long) __b); \
64} while (0)
65
66#define TEST_ASSERT_KVM_EXIT_REASON(vcpu, expected) do { \
67 __u32 exit_reason = (vcpu)->run->exit_reason; \
68 \
69 TEST_ASSERT(exit_reason == (expected), \
70 "Wanted KVM exit reason: %u (%s), got: %u (%s)", \
71 (expected), exit_reason_str((expected)), \
72 exit_reason, exit_reason_str(exit_reason)); \
73} while (0)
74
75#define TEST_FAIL(fmt, ...) do { \
76 TEST_ASSERT(false, fmt, ##__VA_ARGS__); \
77 __builtin_unreachable(); \
78} while (0)
79
80size_t parse_size(const char *size);
81
82int64_t timespec_to_ns(struct timespec ts);
83struct timespec timespec_add_ns(struct timespec ts, int64_t ns);
84struct timespec timespec_add(struct timespec ts1, struct timespec ts2);
85struct timespec timespec_sub(struct timespec ts1, struct timespec ts2);
86struct timespec timespec_elapsed(struct timespec start);
87struct timespec timespec_div(struct timespec ts, int divisor);
88
89struct guest_random_state {
90 uint32_t seed;
91};
92
93struct guest_random_state new_guest_random_state(uint32_t seed);
94uint32_t guest_random_u32(struct guest_random_state *state);
95
96enum vm_mem_backing_src_type {
97 VM_MEM_SRC_ANONYMOUS,
98 VM_MEM_SRC_ANONYMOUS_THP,
99 VM_MEM_SRC_ANONYMOUS_HUGETLB,
100 VM_MEM_SRC_ANONYMOUS_HUGETLB_16KB,
101 VM_MEM_SRC_ANONYMOUS_HUGETLB_64KB,
102 VM_MEM_SRC_ANONYMOUS_HUGETLB_512KB,
103 VM_MEM_SRC_ANONYMOUS_HUGETLB_1MB,
104 VM_MEM_SRC_ANONYMOUS_HUGETLB_2MB,
105 VM_MEM_SRC_ANONYMOUS_HUGETLB_8MB,
106 VM_MEM_SRC_ANONYMOUS_HUGETLB_16MB,
107 VM_MEM_SRC_ANONYMOUS_HUGETLB_32MB,
108 VM_MEM_SRC_ANONYMOUS_HUGETLB_256MB,
109 VM_MEM_SRC_ANONYMOUS_HUGETLB_512MB,
110 VM_MEM_SRC_ANONYMOUS_HUGETLB_1GB,
111 VM_MEM_SRC_ANONYMOUS_HUGETLB_2GB,
112 VM_MEM_SRC_ANONYMOUS_HUGETLB_16GB,
113 VM_MEM_SRC_SHMEM,
114 VM_MEM_SRC_SHARED_HUGETLB,
115 NUM_SRC_TYPES,
116};
117
118#define DEFAULT_VM_MEM_SRC VM_MEM_SRC_ANONYMOUS
119
120struct vm_mem_backing_src_alias {
121 const char *name;
122 uint32_t flag;
123};
124
125#define MIN_RUN_DELAY_NS 200000UL
126
127bool thp_configured(void);
128size_t get_trans_hugepagesz(void);
129size_t get_def_hugetlb_pagesz(void);
130const struct vm_mem_backing_src_alias *vm_mem_backing_src_alias(uint32_t i);
131size_t get_backing_src_pagesz(uint32_t i);
132bool is_backing_src_hugetlb(uint32_t i);
133void backing_src_help(const char *flag);
134enum vm_mem_backing_src_type parse_backing_src_type(const char *type_name);
135long get_run_delay(void);
136
137/*
138 * Whether or not the given source type is shared memory (as opposed to
139 * anonymous).
140 */
141static inline bool backing_src_is_shared(enum vm_mem_backing_src_type t)
142{
143 return vm_mem_backing_src_alias(t)->flag & MAP_SHARED;
144}
145
146/* Aligns x up to the next multiple of size. Size must be a power of 2. */
147static inline uint64_t align_up(uint64_t x, uint64_t size)
148{
149 uint64_t mask = size - 1;
150
151 TEST_ASSERT(size != 0 && !(size & (size - 1)),
152 "size not a power of 2: %lu", size);
153 return ((x + mask) & ~mask);
154}
155
156static inline uint64_t align_down(uint64_t x, uint64_t size)
157{
158 uint64_t x_aligned_up = align_up(x, size);
159
160 if (x == x_aligned_up)
161 return x;
162 else
163 return x_aligned_up - size;
164}
165
166static inline void *align_ptr_up(void *x, size_t size)
167{
168 return (void *)align_up((unsigned long)x, size);
169}
170
171int atoi_paranoid(const char *num_str);
172
173static inline uint32_t atoi_positive(const char *name, const char *num_str)
174{
175 int num = atoi_paranoid(num_str);
176
177 TEST_ASSERT(num > 0, "%s must be greater than 0, got '%s'", name, num_str);
178 return num;
179}
180
181static inline uint32_t atoi_non_negative(const char *name, const char *num_str)
182{
183 int num = atoi_paranoid(num_str);
184
185 TEST_ASSERT(num >= 0, "%s must be non-negative, got '%s'", name, num_str);
186 return num;
187}
188
189#endif /* SELFTEST_KVM_TEST_UTIL_H */