tools/testing/selftests/mm/uffd-common.h
Source file repositories/reference/linux-study-clean/tools/testing/selftests/mm/uffd-common.h
File Facts
- System
- Linux kernel
- Corpus path
tools/testing/selftests/mm/uffd-common.h- Extension
.h- Size
- 4389 bytes
- Lines
- 140
- Domain
- Support Tooling And Documentation
- Bucket
- tools
- Inferred role
- Support Tooling And Documentation: implementation source
- Status
- source implementation candidate
Why This File Exists
Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.
- Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.
- Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
stdio.herrno.hunistd.hstdlib.hsys/types.hsys/stat.hfcntl.htime.hsignal.hpoll.hstring.hlinux/mman.hsys/mman.hsys/syscall.hsys/ioctl.hsys/wait.hpthread.hlinux/userfaultfd.hsetjmp.hstdbool.hassert.hinttypes.hstdint.hsys/random.hstdatomic.hkselftest.hvm_util.h
Detected Declarations
struct uffd_global_test_optsstruct uffd_argsstruct uffd_test_opsstruct uffd_test_case_ops
Annotated Snippet
struct uffd_global_test_opts {
unsigned long nr_parallel, nr_pages, nr_pages_per_cpu, page_size;
char *area_src, *area_src_alias, *area_dst, *area_dst_alias, *area_remap;
int uffd, uffd_flags, finished, *pipefd, test_type;
bool map_shared;
bool test_uffdio_wp;
unsigned long long *count_verify;
volatile bool test_uffdio_copy_eexist;
atomic_bool ready_for_fork;
};
typedef struct uffd_global_test_opts uffd_global_test_opts_t;
/* Userfaultfd test statistics */
struct uffd_args {
int cpu;
/* Whether apply wr-protects when installing pages */
bool apply_wp;
unsigned long missing_faults;
unsigned long wp_faults;
unsigned long minor_faults;
struct uffd_global_test_opts *gopts;
/* A custom fault handler; defaults to uffd_handle_page_fault. */
void (*handle_fault)(struct uffd_global_test_opts *gopts,
struct uffd_msg *msg,
struct uffd_args *args);
};
struct uffd_test_ops {
int (*allocate_area)(uffd_global_test_opts_t *gopts, void **alloc_area, bool is_src);
void (*release_pages)(uffd_global_test_opts_t *gopts, char *rel_area);
void (*alias_mapping)(uffd_global_test_opts_t *gopts,
__u64 *start,
size_t len,
unsigned long offset);
void (*check_pmd_mapping)(uffd_global_test_opts_t *gopts, void *p, int expect_nr_hpages);
};
typedef struct uffd_test_ops uffd_test_ops_t;
struct uffd_test_case_ops {
int (*pre_alloc)(uffd_global_test_opts_t *gopts, const char **errmsg);
int (*post_alloc)(uffd_global_test_opts_t *gopts, const char **errmsg);
};
typedef struct uffd_test_case_ops uffd_test_case_ops_t;
extern uffd_global_test_opts_t *uffd_gtest_opts;
extern uffd_test_ops_t anon_uffd_test_ops;
extern uffd_test_ops_t shmem_uffd_test_ops;
extern uffd_test_ops_t hugetlb_uffd_test_ops;
extern uffd_test_ops_t *uffd_test_ops;
extern uffd_test_case_ops_t *uffd_test_case_ops;
pthread_mutex_t *area_mutex(char *area, unsigned long nr, uffd_global_test_opts_t *gopts);
volatile unsigned long long *area_count(char *area,
unsigned long nr,
uffd_global_test_opts_t *gopts);
void uffd_stats_report(struct uffd_args *args, int n_cpus);
int uffd_test_ctx_init(uffd_global_test_opts_t *gopts, uint64_t features, const char **errmsg);
void uffd_test_ctx_clear(uffd_global_test_opts_t *gopts);
int userfaultfd_open(uffd_global_test_opts_t *gopts, uint64_t *features);
int uffd_read_msg(uffd_global_test_opts_t *gopts, struct uffd_msg *msg);
void wp_range(int ufd, __u64 start, __u64 len, bool wp);
void uffd_handle_page_fault(uffd_global_test_opts_t *gopts,
struct uffd_msg *msg,
struct uffd_args *args);
int __copy_page(uffd_global_test_opts_t *gopts, unsigned long offset, bool retry, bool wp);
int copy_page(uffd_global_test_opts_t *gopts, unsigned long offset, bool wp);
int move_page(uffd_global_test_opts_t *gopts, unsigned long offset, unsigned long len);
void *uffd_poll_thread(void *arg);
int uffd_open_dev(unsigned int flags);
int uffd_open_sys(unsigned int flags);
int uffd_open(unsigned int flags);
int uffd_get_features(uint64_t *features);
#define TEST_ANON 1
#define TEST_HUGETLB 2
#define TEST_SHMEM 3
#endif
Annotation
- Immediate include surface: `stdio.h`, `errno.h`, `unistd.h`, `stdlib.h`, `sys/types.h`, `sys/stat.h`, `fcntl.h`, `time.h`.
- Detected declarations: `struct uffd_global_test_opts`, `struct uffd_args`, `struct uffd_test_ops`, `struct uffd_test_case_ops`.
- Atlas domain: Support Tooling And Documentation / tools.
- Implementation status: source implementation candidate.
- Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.