uffd-common.h

  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#define __SANE_USERSPACE_TYPES__ // Use ll64
 12#include <stdio.h>
 13#include <errno.h>
 14#include <unistd.h>
 15#include <stdlib.h>
 16#include <sys/types.h>
 17#include <sys/stat.h>
 18#include <fcntl.h>
 19#include <time.h>
 20#include <signal.h>
 21#include <poll.h>
 22#include <string.h>
 23#include <linux/mman.h>
 24#include <sys/mman.h>
 25#include <sys/syscall.h>
 26#include <sys/ioctl.h>
 27#include <sys/wait.h>
 28#include <pthread.h>
 29#include <linux/userfaultfd.h>
 30#include <setjmp.h>
 31#include <stdbool.h>
 32#include <assert.h>
 33#include <inttypes.h>
 34#include <stdint.h>
 35#include <sys/random.h>
 36#include <stdatomic.h>
 37
 38#include "kselftest.h"
 39#include "vm_util.h"
 40
 41#define UFFD_FLAGS	(O_CLOEXEC | O_NONBLOCK | UFFD_USER_MODE_ONLY)
 42
 43#define _err(fmt, ...)						\
 44	do {							\
 45		int ret = errno;				\
 46		fprintf(stderr, "ERROR: " fmt, ##__VA_ARGS__);	\
 47		fprintf(stderr, " (errno=%d, @%s:%d)\n",	\
 48			ret, __FILE__, __LINE__);		\
 49	} while (0)
 50
 51#define errexit(exitcode, fmt, ...)		\
 52	do {					\
 53		_err(fmt, ##__VA_ARGS__);	\
 54		exit(exitcode);			\
 55	} while (0)
 56
 57#define err(fmt, ...) errexit(1, fmt, ##__VA_ARGS__)
 58
 59struct uffd_global_test_opts {
 60	unsigned long nr_parallel, nr_pages, nr_pages_per_cpu, page_size;
 61	char *area_src, *area_src_alias, *area_dst, *area_dst_alias, *area_remap;
 62	int uffd, uffd_flags, finished, *pipefd, test_type;
 63	bool map_shared;
 64	bool test_uffdio_wp;
 65	unsigned long long *count_verify;
 66	volatile bool test_uffdio_copy_eexist;
 67	atomic_bool ready_for_fork;
 68};
 69typedef struct uffd_global_test_opts uffd_global_test_opts_t;
 70
 71/* Userfaultfd test statistics */
 72struct uffd_args {
 73	int cpu;
 74	/* Whether apply wr-protects when installing pages */
 75	bool apply_wp;
 76	unsigned long missing_faults;
 77	unsigned long wp_faults;
 78	unsigned long minor_faults;
 79	struct uffd_global_test_opts *gopts;
 80
 81	/* A custom fault handler; defaults to uffd_handle_page_fault. */
 82	void (*handle_fault)(struct uffd_global_test_opts *gopts,
 83			     struct uffd_msg *msg,
 84			     struct uffd_args *args);
 85};
 86
 87struct uffd_test_ops {
 88	int (*allocate_area)(uffd_global_test_opts_t *gopts, void **alloc_area, bool is_src);
 89	void (*release_pages)(uffd_global_test_opts_t *gopts, char *rel_area);
 90	void (*alias_mapping)(uffd_global_test_opts_t *gopts,
 91			      __u64 *start,
 92			      size_t len,
 93			      unsigned long offset);
 94	void (*check_pmd_mapping)(uffd_global_test_opts_t *gopts, void *p, int expect_nr_hpages);
 95};
 96typedef struct uffd_test_ops uffd_test_ops_t;
 97
 98struct uffd_test_case_ops {
 99	int (*pre_alloc)(uffd_global_test_opts_t *gopts, const char **errmsg);
100	int (*post_alloc)(uffd_global_test_opts_t *gopts, const char **errmsg);
101};
102typedef struct uffd_test_case_ops uffd_test_case_ops_t;
103
104extern uffd_global_test_opts_t *uffd_gtest_opts;
105extern uffd_test_ops_t anon_uffd_test_ops;
106extern uffd_test_ops_t shmem_uffd_test_ops;
107extern uffd_test_ops_t hugetlb_uffd_test_ops;
108extern uffd_test_ops_t *uffd_test_ops;
109extern uffd_test_case_ops_t *uffd_test_case_ops;
110
111pthread_mutex_t *area_mutex(char *area, unsigned long nr, uffd_global_test_opts_t *gopts);
112volatile unsigned long long *area_count(char *area,
113					unsigned long nr,
114					uffd_global_test_opts_t *gopts);
115
116void uffd_stats_report(struct uffd_args *args, int n_cpus);
117int uffd_test_ctx_init(uffd_global_test_opts_t *gopts, uint64_t features, const char **errmsg);
118void uffd_test_ctx_clear(uffd_global_test_opts_t *gopts);
119int userfaultfd_open(uffd_global_test_opts_t *gopts, uint64_t *features);
120int uffd_read_msg(uffd_global_test_opts_t *gopts, struct uffd_msg *msg);
121void wp_range(int ufd, __u64 start, __u64 len, bool wp);
122void uffd_handle_page_fault(uffd_global_test_opts_t *gopts,
123			    struct uffd_msg *msg,
124			    struct uffd_args *args);
125int __copy_page(uffd_global_test_opts_t *gopts, unsigned long offset, bool retry, bool wp);
126int copy_page(uffd_global_test_opts_t *gopts, unsigned long offset, bool wp);
127int move_page(uffd_global_test_opts_t *gopts, unsigned long offset, unsigned long len);
128void *uffd_poll_thread(void *arg);
129
130int uffd_open_dev(unsigned int flags);
131int uffd_open_sys(unsigned int flags);
132int uffd_open(unsigned int flags);
133int uffd_get_features(uint64_t *features);
134
135#define TEST_ANON	1
136#define TEST_HUGETLB	2
137#define TEST_SHMEM	3
138
139#endif