root/tools/testing/selftests/kvm/include/test_util.h
/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * tools/testing/selftests/kvm/include/test_util.h
 *
 * Copyright (C) 2018, Google LLC.
 */

#ifndef SELFTEST_KVM_TEST_UTIL_H
#define SELFTEST_KVM_TEST_UTIL_H

#include <setjmp.h>
#include <signal.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <inttypes.h>
#include <errno.h>
#include <unistd.h>
#include <fcntl.h>
#include "kselftest.h"

#include <linux/mman.h>
#include <linux/types.h>

#define msecs_to_usecs(msec)    ((msec) * 1000ULL)

static inline __printf(1, 2) int _no_printf(const char *format, ...) { return 0; }

#ifdef DEBUG
#define pr_debug(...) printf(__VA_ARGS__)
#else
#define pr_debug(...) _no_printf(__VA_ARGS__)
#endif
#ifndef QUIET
#define pr_info(...) printf(__VA_ARGS__)
#else
#define pr_info(...) _no_printf(__VA_ARGS__)
#endif

void __printf(1, 2) print_skip(const char *fmt, ...);
#define __TEST_REQUIRE(f, fmt, ...)                             \
do {                                                            \
        if (!(f))                                               \
                ksft_exit_skip("- " fmt "\n", ##__VA_ARGS__);   \
} while (0)

#define TEST_REQUIRE(f) __TEST_REQUIRE(f, "Requirement not met: %s", #f)

ssize_t test_write(int fd, const void *buf, size_t count);
ssize_t test_read(int fd, void *buf, size_t count);
int test_seq_read(const char *path, char **bufp, size_t *sizep);

void __printf(5, 6) test_assert(bool exp, const char *exp_str,
                                const char *file, unsigned int line,
                                const char *fmt, ...);

#define TEST_ASSERT(e, fmt, ...) \
        test_assert((e), #e, __FILE__, __LINE__, fmt, ##__VA_ARGS__)

#define TEST_ASSERT_EQ(a, b)                                            \
do {                                                                    \
        typeof(a) __a = (a);                                            \
        typeof(b) __b = (b);                                            \
        test_assert(__a == __b, #a " == " #b, __FILE__, __LINE__,       \
                    "%#lx != %#lx (%s != %s)",                          \
                    (unsigned long)(__a), (unsigned long)(__b), #a, #b);\
} while (0)

#define TEST_ASSERT_KVM_EXIT_REASON(vcpu, expected) do {                \
        __u32 exit_reason = (vcpu)->run->exit_reason;                   \
                                                                        \
        TEST_ASSERT(exit_reason == (expected),                          \
                    "Wanted KVM exit reason: %u (%s), got: %u (%s)",    \
                    (expected), exit_reason_str((expected)),            \
                    exit_reason, exit_reason_str(exit_reason));         \
} while (0)

#define TEST_FAIL(fmt, ...) do { \
        TEST_ASSERT(false, fmt, ##__VA_ARGS__); \
        __builtin_unreachable(); \
} while (0)

extern sigjmp_buf expect_sigbus_jmpbuf;
void expect_sigbus_handler(int signum);

#define TEST_EXPECT_SIGBUS(action)                                              \
do {                                                                            \
        struct sigaction sa_old, sa_new = {                                     \
                .sa_handler = expect_sigbus_handler,                            \
        };                                                                      \
                                                                                \
        sigaction(SIGBUS, &sa_new, &sa_old);                                    \
        if (sigsetjmp(expect_sigbus_jmpbuf, 1) == 0) {                          \
                action;                                                         \
                TEST_FAIL("'%s' should have triggered SIGBUS", #action);        \
        }                                                                       \
        sigaction(SIGBUS, &sa_old, NULL);                                       \
} while (0)

size_t parse_size(const char *size);

s64 timespec_to_ns(struct timespec ts);
struct timespec timespec_add_ns(struct timespec ts, s64 ns);
struct timespec timespec_add(struct timespec ts1, struct timespec ts2);
struct timespec timespec_sub(struct timespec ts1, struct timespec ts2);
struct timespec timespec_elapsed(struct timespec start);
struct timespec timespec_div(struct timespec ts, int divisor);

struct guest_random_state {
        u32 seed;
};

extern u32 guest_random_seed;
extern struct guest_random_state guest_rng;

struct guest_random_state new_guest_random_state(u32 seed);
u32 guest_random_u32(struct guest_random_state *state);

static inline bool __guest_random_bool(struct guest_random_state *state,
                                       u8 percent)
{
        return (guest_random_u32(state) % 100) < percent;
}

static inline bool guest_random_bool(struct guest_random_state *state)
{
        return __guest_random_bool(state, 50);
}

static inline u64 guest_random_u64(struct guest_random_state *state)
{
        return ((u64)guest_random_u32(state) << 32) | guest_random_u32(state);
}

enum vm_mem_backing_src_type {
        VM_MEM_SRC_ANONYMOUS,
        VM_MEM_SRC_ANONYMOUS_THP,
        VM_MEM_SRC_ANONYMOUS_HUGETLB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_16KB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_64KB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_512KB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_1MB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_2MB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_8MB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_16MB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_32MB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_256MB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_512MB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_1GB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_2GB,
        VM_MEM_SRC_ANONYMOUS_HUGETLB_16GB,
        VM_MEM_SRC_SHMEM,
        VM_MEM_SRC_SHARED_HUGETLB,
        NUM_SRC_TYPES,
};

#define DEFAULT_VM_MEM_SRC VM_MEM_SRC_ANONYMOUS

struct vm_mem_backing_src_alias {
        const char *name;
        u32 flag;
};

#define MIN_RUN_DELAY_NS        200000UL

bool thp_configured(void);
size_t get_trans_hugepagesz(void);
size_t get_def_hugetlb_pagesz(void);
const struct vm_mem_backing_src_alias *vm_mem_backing_src_alias(u32 i);
size_t get_backing_src_pagesz(u32 i);
bool is_backing_src_hugetlb(u32 i);
void backing_src_help(const char *flag);
enum vm_mem_backing_src_type parse_backing_src_type(const char *type_name);
long get_run_delay(void);
bool is_numa_balancing_enabled(void);

/*
 * Whether or not the given source type is shared memory (as opposed to
 * anonymous).
 */
static inline bool backing_src_is_shared(enum vm_mem_backing_src_type t)
{
        return vm_mem_backing_src_alias(t)->flag & MAP_SHARED;
}

static inline bool backing_src_can_be_huge(enum vm_mem_backing_src_type t)
{
        return t != VM_MEM_SRC_ANONYMOUS && t != VM_MEM_SRC_SHMEM;
}

/* Aligns x up to the next multiple of size. Size must be a power of 2. */
static inline u64 align_up(u64 x, u64 size)
{
        u64 mask = size - 1;

        TEST_ASSERT(size != 0 && !(size & (size - 1)),
                    "size not a power of 2: %lu", size);
        return ((x + mask) & ~mask);
}

static inline u64 align_down(u64 x, u64 size)
{
        u64 x_aligned_up = align_up(x, size);

        if (x == x_aligned_up)
                return x;
        else
                return x_aligned_up - size;
}

static inline void *align_ptr_up(void *x, size_t size)
{
        return (void *)align_up((unsigned long)x, size);
}

int atoi_paranoid(const char *num_str);

static inline u32 atoi_positive(const char *name, const char *num_str)
{
        int num = atoi_paranoid(num_str);

        TEST_ASSERT(num > 0, "%s must be greater than 0, got '%s'", name, num_str);
        return num;
}

static inline u32 atoi_non_negative(const char *name, const char *num_str)
{
        int num = atoi_paranoid(num_str);

        TEST_ASSERT(num >= 0, "%s must be non-negative, got '%s'", name, num_str);
        return num;
}

int guest_vsnprintf(char *buf, int n, const char *fmt, va_list args);
__printf(3, 4) int guest_snprintf(char *buf, int n, const char *fmt, ...);

char *strdup_printf(const char *fmt, ...) __attribute__((format(printf, 1, 2), nonnull(1)));

char *sys_get_cur_clocksource(void);

#endif /* SELFTEST_KVM_TEST_UTIL_H */