1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Userfaultfd tests common header
4 *
5 * Copyright (C) 2015-2023  Red Hat, Inc.
6 */
7#ifndef __UFFD_COMMON_H__
8#define __UFFD_COMMON_H__
9
10#define _GNU_SOURCE
11#include <stdio.h>
12#include <errno.h>
13#include <unistd.h>
14#include <stdlib.h>
15#include <sys/types.h>
16#include <sys/stat.h>
17#include <fcntl.h>
18#include <time.h>
19#include <signal.h>
20#include <poll.h>
21#include <string.h>
22#include <linux/mman.h>
23#include <sys/mman.h>
24#include <sys/syscall.h>
25#include <sys/ioctl.h>
26#include <sys/wait.h>
27#include <pthread.h>
28#include <linux/userfaultfd.h>
29#include <setjmp.h>
30#include <stdbool.h>
31#include <assert.h>
32#include <inttypes.h>
33#include <stdint.h>
34#include <sys/random.h>
35
36#include "../kselftest.h"
37#include "vm_util.h"
38
39#define UFFD_FLAGS	(O_CLOEXEC | O_NONBLOCK | UFFD_USER_MODE_ONLY)
40
41#define _err(fmt, ...)						\
42	do {							\
43		int ret = errno;				\
44		fprintf(stderr, "ERROR: " fmt, ##__VA_ARGS__);	\
45		fprintf(stderr, " (errno=%d, @%s:%d)\n",	\
46			ret, __FILE__, __LINE__);		\
47	} while (0)
48
49#define errexit(exitcode, fmt, ...)		\
50	do {					\
51		_err(fmt, ##__VA_ARGS__);	\
52		exit(exitcode);			\
53	} while (0)
54
55#define err(fmt, ...) errexit(1, fmt, ##__VA_ARGS__)
56
57/* pthread_mutex_t starts at page offset 0 */
58#define area_mutex(___area, ___nr)					\
59	((pthread_mutex_t *) ((___area) + (___nr)*page_size))
60/*
61 * count is placed in the page after pthread_mutex_t naturally aligned
62 * to avoid non alignment faults on non-x86 archs.
63 */
64#define area_count(___area, ___nr)					\
65	((volatile unsigned long long *) ((unsigned long)		\
66				 ((___area) + (___nr)*page_size +	\
67				  sizeof(pthread_mutex_t) +		\
68				  sizeof(unsigned long long) - 1) &	\
69				 ~(unsigned long)(sizeof(unsigned long long) \
70						  -  1)))
71
72/* Userfaultfd test statistics */
73struct uffd_args {
74	int cpu;
75	/* Whether apply wr-protects when installing pages */
76	bool apply_wp;
77	unsigned long missing_faults;
78	unsigned long wp_faults;
79	unsigned long minor_faults;
80
81	/* A custom fault handler; defaults to uffd_handle_page_fault. */
82	void (*handle_fault)(struct uffd_msg *msg, struct uffd_args *args);
83};
84
85struct uffd_test_ops {
86	int (*allocate_area)(void **alloc_area, bool is_src);
87	void (*release_pages)(char *rel_area);
88	void (*alias_mapping)(__u64 *start, size_t len, unsigned long offset);
89	void (*check_pmd_mapping)(void *p, int expect_nr_hpages);
90};
91typedef struct uffd_test_ops uffd_test_ops_t;
92
93extern unsigned long nr_cpus, nr_pages, nr_pages_per_cpu, page_size;
94extern char *area_src, *area_src_alias, *area_dst, *area_dst_alias, *area_remap;
95extern int uffd, uffd_flags, finished, *pipefd, test_type;
96extern bool map_shared;
97extern bool test_uffdio_wp;
98extern unsigned long long *count_verify;
99extern volatile bool test_uffdio_copy_eexist;
100
101extern uffd_test_ops_t anon_uffd_test_ops;
102extern uffd_test_ops_t shmem_uffd_test_ops;
103extern uffd_test_ops_t hugetlb_uffd_test_ops;
104extern uffd_test_ops_t *uffd_test_ops;
105
106void uffd_stats_report(struct uffd_args *args, int n_cpus);
107int uffd_test_ctx_init(uint64_t features, const char **errmsg);
108int userfaultfd_open(uint64_t *features);
109int uffd_read_msg(int ufd, struct uffd_msg *msg);
110void wp_range(int ufd, __u64 start, __u64 len, bool wp);
111void uffd_handle_page_fault(struct uffd_msg *msg, struct uffd_args *args);
112int __copy_page(int ufd, unsigned long offset, bool retry, bool wp);
113int copy_page(int ufd, unsigned long offset, bool wp);
114void *uffd_poll_thread(void *arg);
115
116int uffd_open_dev(unsigned int flags);
117int uffd_open_sys(unsigned int flags);
118int uffd_open(unsigned int flags);
119int uffd_get_features(uint64_t *features);
120
121#define TEST_ANON	1
122#define TEST_HUGETLB	2
123#define TEST_SHMEM	3
124
125#endif
126