]>
Commit | Line | Data |
---|---|---|
7a338472 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
783e9e51 PB |
2 | /* |
3 | * tools/testing/selftests/kvm/include/kvm_util.h | |
4 | * | |
5 | * Copyright (C) 2018, Google LLC. | |
783e9e51 PB |
6 | */ |
7 | #ifndef SELFTEST_KVM_UTIL_H | |
cc68765d | 8 | #define SELFTEST_KVM_UTIL_H |
783e9e51 PB |
9 | |
10 | #include "test_util.h" | |
11 | ||
12 | #include "asm/kvm.h" | |
13 | #include "linux/kvm.h" | |
14 | #include <sys/ioctl.h> | |
15 | ||
16 | #include "sparsebit.h" | |
17 | ||
783e9e51 PB |
18 | |
19 | /* Callers of kvm_util only have an incomplete/opaque description of the | |
20 | * structure kvm_util is using to maintain the state of a VM. | |
21 | */ | |
22 | struct kvm_vm; | |
23 | ||
24 | typedef uint64_t vm_paddr_t; /* Virtual Machine (Guest) physical address */ | |
25 | typedef uint64_t vm_vaddr_t; /* Virtual Machine (Guest) virtual address */ | |
26 | ||
27 | /* Minimum allocated guest virtual and physical addresses */ | |
eabe7881 | 28 | #define KVM_UTIL_MIN_VADDR 0x2000 |
783e9e51 PB |
29 | |
30 | #define DEFAULT_GUEST_PHY_PAGES 512 | |
31 | #define DEFAULT_GUEST_STACK_VADDR_MIN 0xab6000 | |
eabe7881 | 32 | #define DEFAULT_STACK_PGS 5 |
783e9e51 PB |
33 | |
34 | enum vm_guest_mode { | |
81d1cca0 AJ |
35 | VM_MODE_P52V48_4K, |
36 | VM_MODE_P52V48_64K, | |
cdbd2428 AJ |
37 | VM_MODE_P48V48_4K, |
38 | VM_MODE_P48V48_64K, | |
e28934e6 AJ |
39 | VM_MODE_P40V48_4K, |
40 | VM_MODE_P40V48_64K, | |
81d1cca0 | 41 | NUM_VM_MODES, |
783e9e51 PB |
42 | }; |
43 | ||
81d1cca0 AJ |
44 | #define vm_guest_mode_string(m) vm_guest_mode_string[m] |
45 | extern const char * const vm_guest_mode_string[]; | |
46 | ||
783e9e51 PB |
47 | enum vm_mem_backing_src_type { |
48 | VM_MEM_SRC_ANONYMOUS, | |
49 | VM_MEM_SRC_ANONYMOUS_THP, | |
50 | VM_MEM_SRC_ANONYMOUS_HUGETLB, | |
51 | }; | |
52 | ||
53 | int kvm_check_cap(long cap); | |
8b56ee91 | 54 | int vm_enable_cap(struct kvm_vm *vm, struct kvm_enable_cap *cap); |
783e9e51 PB |
55 | |
56 | struct kvm_vm *vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm); | |
8cee5816 AJ |
57 | struct kvm_vm *_vm_create(enum vm_guest_mode mode, uint64_t phy_pages, |
58 | int perm, unsigned long type); | |
783e9e51 | 59 | void kvm_vm_free(struct kvm_vm *vmp); |
fa3899ad PB |
60 | void kvm_vm_restart(struct kvm_vm *vmp, int perm); |
61 | void kvm_vm_release(struct kvm_vm *vmp); | |
3b4cd0ff | 62 | void kvm_vm_get_dirty_log(struct kvm_vm *vm, int slot, void *log); |
2a31b9db PB |
63 | void kvm_vm_clear_dirty_log(struct kvm_vm *vm, int slot, void *log, |
64 | uint64_t first_page, uint32_t num_pages); | |
783e9e51 | 65 | |
eabe7881 AJ |
66 | int kvm_memcmp_hva_gva(void *hva, struct kvm_vm *vm, const vm_vaddr_t gva, |
67 | size_t len); | |
783e9e51 | 68 | |
6089ae0b | 69 | void kvm_vm_elf_load(struct kvm_vm *vm, const char *filename, |
eabe7881 | 70 | uint32_t data_memslot, uint32_t pgd_memslot); |
6089ae0b | 71 | |
783e9e51 | 72 | void vm_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent); |
eabe7881 AJ |
73 | void vcpu_dump(FILE *stream, struct kvm_vm *vm, uint32_t vcpuid, |
74 | uint8_t indent); | |
783e9e51 PB |
75 | |
76 | void vm_create_irqchip(struct kvm_vm *vm); | |
77 | ||
78 | void vm_userspace_mem_region_add(struct kvm_vm *vm, | |
79 | enum vm_mem_backing_src_type src_type, | |
80 | uint64_t guest_paddr, uint32_t slot, uint64_t npages, | |
81 | uint32_t flags); | |
82 | ||
eabe7881 AJ |
83 | void vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, |
84 | void *arg); | |
7e50c424 VK |
85 | int _vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, |
86 | void *arg); | |
783e9e51 PB |
87 | void vm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg); |
88 | void vm_mem_region_set_flags(struct kvm_vm *vm, uint32_t slot, uint32_t flags); | |
eabe7881 AJ |
89 | void vm_vcpu_add(struct kvm_vm *vm, uint32_t vcpuid, int pgd_memslot, |
90 | int gdt_memslot); | |
783e9e51 | 91 | vm_vaddr_t vm_vaddr_alloc(struct kvm_vm *vm, size_t sz, vm_vaddr_t vaddr_min, |
eabe7881 | 92 | uint32_t data_memslot, uint32_t pgd_memslot); |
3b4cd0ff PX |
93 | void virt_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, |
94 | size_t size, uint32_t pgd_memslot); | |
783e9e51 PB |
95 | void *addr_gpa2hva(struct kvm_vm *vm, vm_paddr_t gpa); |
96 | void *addr_gva2hva(struct kvm_vm *vm, vm_vaddr_t gva); | |
97 | vm_paddr_t addr_hva2gpa(struct kvm_vm *vm, void *hva); | |
98 | vm_paddr_t addr_gva2gpa(struct kvm_vm *vm, vm_vaddr_t gva); | |
99 | ||
100 | struct kvm_run *vcpu_state(struct kvm_vm *vm, uint32_t vcpuid); | |
101 | void vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); | |
102 | int _vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); | |
0f73bbc8 | 103 | void vcpu_run_complete_io(struct kvm_vm *vm, uint32_t vcpuid); |
783e9e51 | 104 | void vcpu_set_mp_state(struct kvm_vm *vm, uint32_t vcpuid, |
eabe7881 AJ |
105 | struct kvm_mp_state *mp_state); |
106 | void vcpu_regs_get(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs); | |
107 | void vcpu_regs_set(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs); | |
783e9e51 | 108 | void vcpu_args_set(struct kvm_vm *vm, uint32_t vcpuid, unsigned int num, ...); |
eabe7881 AJ |
109 | void vcpu_sregs_get(struct kvm_vm *vm, uint32_t vcpuid, |
110 | struct kvm_sregs *sregs); | |
111 | void vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid, | |
112 | struct kvm_sregs *sregs); | |
113 | int _vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid, | |
114 | struct kvm_sregs *sregs); | |
783e9e51 | 115 | void vcpu_events_get(struct kvm_vm *vm, uint32_t vcpuid, |
eabe7881 | 116 | struct kvm_vcpu_events *events); |
783e9e51 | 117 | void vcpu_events_set(struct kvm_vm *vm, uint32_t vcpuid, |
eabe7881 | 118 | struct kvm_vcpu_events *events); |
c7957206 | 119 | #ifdef __x86_64__ |
da1e3071 AL |
120 | void vcpu_nested_state_get(struct kvm_vm *vm, uint32_t vcpuid, |
121 | struct kvm_nested_state *state); | |
122 | int vcpu_nested_state_set(struct kvm_vm *vm, uint32_t vcpuid, | |
123 | struct kvm_nested_state *state, bool ignore_error); | |
c7957206 | 124 | #endif |
783e9e51 PB |
125 | |
126 | const char *exit_reason_str(unsigned int exit_reason); | |
127 | ||
128 | void virt_pgd_alloc(struct kvm_vm *vm, uint32_t pgd_memslot); | |
129 | void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, | |
eabe7881 AJ |
130 | uint32_t pgd_memslot); |
131 | vm_paddr_t vm_phy_page_alloc(struct kvm_vm *vm, vm_paddr_t paddr_min, | |
132 | uint32_t memslot); | |
d5106539 AJ |
133 | vm_paddr_t vm_phy_pages_alloc(struct kvm_vm *vm, size_t num, |
134 | vm_paddr_t paddr_min, uint32_t memslot); | |
783e9e51 | 135 | |
aee41be5 PX |
136 | struct kvm_vm *vm_create_default(uint32_t vcpuid, uint64_t extra_mem_size, |
137 | void *guest_code); | |
783e9e51 PB |
138 | void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code); |
139 | ||
140 | struct kvm_userspace_memory_region * | |
141 | kvm_userspace_memory_region_find(struct kvm_vm *vm, uint64_t start, | |
142 | uint64_t end); | |
143 | ||
144 | struct kvm_dirty_log * | |
145 | allocate_kvm_dirty_log(struct kvm_userspace_memory_region *region); | |
146 | ||
147 | int vm_create_device(struct kvm_vm *vm, struct kvm_create_device *cd); | |
148 | ||
14c47b75 AJ |
149 | #define sync_global_to_guest(vm, g) ({ \ |
150 | typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ | |
151 | memcpy(_p, &(g), sizeof(g)); \ | |
152 | }) | |
153 | ||
154 | #define sync_global_from_guest(vm, g) ({ \ | |
155 | typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ | |
156 | memcpy(&(g), _p, sizeof(g)); \ | |
157 | }) | |
158 | ||
159 | /* ucall implementation types */ | |
160 | typedef enum { | |
161 | UCALL_PIO, | |
162 | UCALL_MMIO, | |
163 | } ucall_type_t; | |
164 | ||
165 | /* Common ucalls */ | |
166 | enum { | |
167 | UCALL_NONE, | |
168 | UCALL_SYNC, | |
169 | UCALL_ABORT, | |
170 | UCALL_DONE, | |
171 | }; | |
4e18bccc | 172 | |
14c47b75 | 173 | #define UCALL_MAX_ARGS 6 |
4e18bccc | 174 | |
14c47b75 AJ |
175 | struct ucall { |
176 | uint64_t cmd; | |
177 | uint64_t args[UCALL_MAX_ARGS]; | |
178 | }; | |
4e18bccc | 179 | |
14c47b75 AJ |
180 | void ucall_init(struct kvm_vm *vm, ucall_type_t type, void *arg); |
181 | void ucall_uninit(struct kvm_vm *vm); | |
182 | void ucall(uint64_t cmd, int nargs, ...); | |
183 | uint64_t get_ucall(struct kvm_vm *vm, uint32_t vcpu_id, struct ucall *uc); | |
184 | ||
185 | #define GUEST_SYNC(stage) ucall(UCALL_SYNC, 2, "hello", stage) | |
186 | #define GUEST_DONE() ucall(UCALL_DONE, 0) | |
187 | #define GUEST_ASSERT(_condition) do { \ | |
188 | if (!(_condition)) \ | |
189 | ucall(UCALL_ABORT, 2, \ | |
190 | "Failed guest assert: " \ | |
191 | #_condition, __LINE__); \ | |
192 | } while (0) | |
4e18bccc | 193 | |
783e9e51 | 194 | #endif /* SELFTEST_KVM_UTIL_H */ |