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 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_FAIL(fmt, ...) do { \ 67 TEST_ASSERT(false, fmt, ##__VA_ARGS__); \ 68 __builtin_unreachable(); \ 69 } while (0) 70 71 size_t parse_size(const char *size); 72 73 int64_t timespec_to_ns(struct timespec ts); 74 struct timespec timespec_add_ns(struct timespec ts, int64_t ns); 75 struct timespec timespec_add(struct timespec ts1, struct timespec ts2); 76 struct timespec timespec_sub(struct timespec ts1, struct timespec ts2); 77 struct timespec timespec_elapsed(struct timespec start); 78 struct timespec timespec_div(struct timespec ts, int divisor); 79 80 struct guest_random_state { 81 uint32_t seed; 82 }; 83 84 struct guest_random_state new_guest_random_state(uint32_t seed); 85 uint32_t guest_random_u32(struct guest_random_state *state); 86 87 enum vm_mem_backing_src_type { 88 VM_MEM_SRC_ANONYMOUS, 89 VM_MEM_SRC_ANONYMOUS_THP, 90 VM_MEM_SRC_ANONYMOUS_HUGETLB, 91 VM_MEM_SRC_ANONYMOUS_HUGETLB_16KB, 92 VM_MEM_SRC_ANONYMOUS_HUGETLB_64KB, 93 VM_MEM_SRC_ANONYMOUS_HUGETLB_512KB, 94 VM_MEM_SRC_ANONYMOUS_HUGETLB_1MB, 95 VM_MEM_SRC_ANONYMOUS_HUGETLB_2MB, 96 VM_MEM_SRC_ANONYMOUS_HUGETLB_8MB, 97 VM_MEM_SRC_ANONYMOUS_HUGETLB_16MB, 98 VM_MEM_SRC_ANONYMOUS_HUGETLB_32MB, 99 VM_MEM_SRC_ANONYMOUS_HUGETLB_256MB, 100 VM_MEM_SRC_ANONYMOUS_HUGETLB_512MB, 101 VM_MEM_SRC_ANONYMOUS_HUGETLB_1GB, 102 VM_MEM_SRC_ANONYMOUS_HUGETLB_2GB, 103 VM_MEM_SRC_ANONYMOUS_HUGETLB_16GB, 104 VM_MEM_SRC_SHMEM, 105 VM_MEM_SRC_SHARED_HUGETLB, 106 NUM_SRC_TYPES, 107 }; 108 109 #define DEFAULT_VM_MEM_SRC VM_MEM_SRC_ANONYMOUS 110 111 struct vm_mem_backing_src_alias { 112 const char *name; 113 uint32_t flag; 114 }; 115 116 #define MIN_RUN_DELAY_NS 200000UL 117 118 bool thp_configured(void); 119 size_t get_trans_hugepagesz(void); 120 size_t get_def_hugetlb_pagesz(void); 121 const struct vm_mem_backing_src_alias *vm_mem_backing_src_alias(uint32_t i); 122 size_t get_backing_src_pagesz(uint32_t i); 123 bool is_backing_src_hugetlb(uint32_t i); 124 void backing_src_help(const char *flag); 125 enum vm_mem_backing_src_type parse_backing_src_type(const char *type_name); 126 long get_run_delay(void); 127 128 /* 129 * Whether or not the given source type is shared memory (as opposed to 130 * anonymous). 131 */ 132 static inline bool backing_src_is_shared(enum vm_mem_backing_src_type t) 133 { 134 return vm_mem_backing_src_alias(t)->flag & MAP_SHARED; 135 } 136 137 /* Aligns x up to the next multiple of size. Size must be a power of 2. */ 138 static inline uint64_t align_up(uint64_t x, uint64_t size) 139 { 140 uint64_t mask = size - 1; 141 142 TEST_ASSERT(size != 0 && !(size & (size - 1)), 143 "size not a power of 2: %lu", size); 144 return ((x + mask) & ~mask); 145 } 146 147 static inline uint64_t align_down(uint64_t x, uint64_t size) 148 { 149 uint64_t x_aligned_up = align_up(x, size); 150 151 if (x == x_aligned_up) 152 return x; 153 else 154 return x_aligned_up - size; 155 } 156 157 static inline void *align_ptr_up(void *x, size_t size) 158 { 159 return (void *)align_up((unsigned long)x, size); 160 } 161 162 int atoi_paranoid(const char *num_str); 163 164 static inline uint32_t atoi_positive(const char *name, const char *num_str) 165 { 166 int num = atoi_paranoid(num_str); 167 168 TEST_ASSERT(num > 0, "%s must be greater than 0, got '%s'", name, num_str); 169 return num; 170 } 171 172 static inline uint32_t atoi_non_negative(const char *name, const char *num_str) 173 { 174 int num = atoi_paranoid(num_str); 175 176 TEST_ASSERT(num >= 0, "%s must be non-negative, got '%s'", name, num_str); 177 return num; 178 } 179 180 #endif /* SELFTEST_KVM_TEST_UTIL_H */ 181