1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * tools/testing/selftests/kvm/include/kvm_util.h
4 *
5 * Copyright (C) 2018, Google LLC.
6 */
7 #ifndef SELFTEST_KVM_UTIL_H
8 #define SELFTEST_KVM_UTIL_H
9
10 #include "test_util.h"
11
12 #include "asm/kvm.h"
13 #include "linux/list.h"
14 #include "linux/kvm.h"
15 #include <sys/ioctl.h>
16
17 #include "sparsebit.h"
18
19 #define KVM_DEV_PATH "/dev/kvm"
20 #define KVM_MAX_VCPUS 512
21
22 /*
23 * Callers of kvm_util only have an incomplete/opaque description of the
24 * structure kvm_util is using to maintain the state of a VM.
25 */
26 struct kvm_vm;
27
28 typedef uint64_t vm_paddr_t; /* Virtual Machine (Guest) physical address */
29 typedef uint64_t vm_vaddr_t; /* Virtual Machine (Guest) virtual address */
30
31 /* Minimum allocated guest virtual and physical addresses */
32 #define KVM_UTIL_MIN_VADDR 0x2000
33
34 #define DEFAULT_GUEST_PHY_PAGES 512
35 #define DEFAULT_GUEST_STACK_VADDR_MIN 0xab6000
36 #define DEFAULT_STACK_PGS 5
37
38 enum vm_guest_mode {
39 VM_MODE_P52V48_4K,
40 VM_MODE_P52V48_64K,
41 VM_MODE_P48V48_4K,
42 VM_MODE_P48V48_64K,
43 VM_MODE_P40V48_4K,
44 VM_MODE_P40V48_64K,
45 VM_MODE_PXXV48_4K, /* For 48bits VA but ANY bits PA */
46 NUM_VM_MODES,
47 };
48
49 #if defined(__aarch64__)
50
51 #define VM_MODE_DEFAULT VM_MODE_P40V48_4K
52 #define MIN_PAGE_SHIFT 12U
53 #define ptes_per_page(page_size) ((page_size) / 8)
54
55 #elif defined(__x86_64__)
56
57 #define VM_MODE_DEFAULT VM_MODE_PXXV48_4K
58 #define MIN_PAGE_SHIFT 12U
59 #define ptes_per_page(page_size) ((page_size) / 8)
60
61 #elif defined(__s390x__)
62
63 #define VM_MODE_DEFAULT VM_MODE_P52V48_4K
64 #define MIN_PAGE_SHIFT 12U
65 #define ptes_per_page(page_size) ((page_size) / 16)
66
67 #endif
68
69 #define MIN_PAGE_SIZE (1U << MIN_PAGE_SHIFT)
70 #define PTES_PER_MIN_PAGE ptes_per_page(MIN_PAGE_SIZE)
71
72 struct vm_guest_mode_params {
73 unsigned int pa_bits;
74 unsigned int va_bits;
75 unsigned int page_size;
76 unsigned int page_shift;
77 };
78 extern const struct vm_guest_mode_params vm_guest_mode_params[];
79
80 int kvm_check_cap(long cap);
81 int vm_enable_cap(struct kvm_vm *vm, struct kvm_enable_cap *cap);
82 int vcpu_enable_cap(struct kvm_vm *vm, uint32_t vcpu_id,
83 struct kvm_enable_cap *cap);
84 void vm_enable_dirty_ring(struct kvm_vm *vm, uint32_t ring_size);
85 const char *vm_guest_mode_string(uint32_t i);
86
87 struct kvm_vm *vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm);
88 void kvm_vm_free(struct kvm_vm *vmp);
89 void kvm_vm_restart(struct kvm_vm *vmp, int perm);
90 void kvm_vm_release(struct kvm_vm *vmp);
91 void kvm_vm_get_dirty_log(struct kvm_vm *vm, int slot, void *log);
92 void kvm_vm_clear_dirty_log(struct kvm_vm *vm, int slot, void *log,
93 uint64_t first_page, uint32_t num_pages);
94 uint32_t kvm_vm_reset_dirty_ring(struct kvm_vm *vm);
95
96 int kvm_memcmp_hva_gva(void *hva, struct kvm_vm *vm, const vm_vaddr_t gva,
97 size_t len);
98
99 void kvm_vm_elf_load(struct kvm_vm *vm, const char *filename,
100 uint32_t data_memslot, uint32_t pgd_memslot);
101
102 void vm_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent);
103
104 /*
105 * VM VCPU Dump
106 *
107 * Input Args:
108 * stream - Output FILE stream
109 * vm - Virtual Machine
110 * vcpuid - VCPU ID
111 * indent - Left margin indent amount
112 *
113 * Output Args: None
114 *
115 * Return: None
116 *
117 * Dumps the current state of the VCPU specified by @vcpuid, within the VM
118 * given by @vm, to the FILE stream given by @stream.
119 */
120 void vcpu_dump(FILE *stream, struct kvm_vm *vm, uint32_t vcpuid,
121 uint8_t indent);
122
123 void vm_create_irqchip(struct kvm_vm *vm);
124
125 void vm_userspace_mem_region_add(struct kvm_vm *vm,
126 enum vm_mem_backing_src_type src_type,
127 uint64_t guest_paddr, uint32_t slot, uint64_t npages,
128 uint32_t flags);
129
130 void vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl,
131 void *arg);
132 int _vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl,
133 void *arg);
134 void vm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg);
135 int _vm_ioctl(struct kvm_vm *vm, unsigned long cmd, void *arg);
136 void kvm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg);
137 int _kvm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg);
138 void vm_mem_region_set_flags(struct kvm_vm *vm, uint32_t slot, uint32_t flags);
139 void vm_mem_region_move(struct kvm_vm *vm, uint32_t slot, uint64_t new_gpa);
140 void vm_mem_region_delete(struct kvm_vm *vm, uint32_t slot);
141 void vm_vcpu_add(struct kvm_vm *vm, uint32_t vcpuid);
142 vm_vaddr_t vm_vaddr_alloc(struct kvm_vm *vm, size_t sz, vm_vaddr_t vaddr_min,
143 uint32_t data_memslot, uint32_t pgd_memslot);
144 void virt_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr,
145 unsigned int npages, uint32_t pgd_memslot);
146 void *addr_gpa2hva(struct kvm_vm *vm, vm_paddr_t gpa);
147 void *addr_gva2hva(struct kvm_vm *vm, vm_vaddr_t gva);
148 vm_paddr_t addr_hva2gpa(struct kvm_vm *vm, void *hva);
149
150 /*
151 * Address Guest Virtual to Guest Physical
152 *
153 * Input Args:
154 * vm - Virtual Machine
155 * gva - VM virtual address
156 *
157 * Output Args: None
158 *
159 * Return:
160 * Equivalent VM physical address
161 *
162 * Returns the VM physical address of the translated VM virtual
163 * address given by @gva.
164 */
165 vm_paddr_t addr_gva2gpa(struct kvm_vm *vm, vm_vaddr_t gva);
166
167 struct kvm_run *vcpu_state(struct kvm_vm *vm, uint32_t vcpuid);
168 void vcpu_run(struct kvm_vm *vm, uint32_t vcpuid);
169 int _vcpu_run(struct kvm_vm *vm, uint32_t vcpuid);
170 int vcpu_get_fd(struct kvm_vm *vm, uint32_t vcpuid);
171 void vcpu_run_complete_io(struct kvm_vm *vm, uint32_t vcpuid);
172 void vcpu_set_guest_debug(struct kvm_vm *vm, uint32_t vcpuid,
173 struct kvm_guest_debug *debug);
174 void vcpu_set_mp_state(struct kvm_vm *vm, uint32_t vcpuid,
175 struct kvm_mp_state *mp_state);
176 struct kvm_reg_list *vcpu_get_reg_list(struct kvm_vm *vm, uint32_t vcpuid);
177 void vcpu_regs_get(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs);
178 void vcpu_regs_set(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs);
179
180 /*
181 * VM VCPU Args Set
182 *
183 * Input Args:
184 * vm - Virtual Machine
185 * vcpuid - VCPU ID
186 * num - number of arguments
187 * ... - arguments, each of type uint64_t
188 *
189 * Output Args: None
190 *
191 * Return: None
192 *
193 * Sets the first @num function input registers of the VCPU with @vcpuid,
194 * per the C calling convention of the architecture, to the values given
195 * as variable args. Each of the variable args is expected to be of type
196 * uint64_t. The maximum @num can be is specific to the architecture.
197 */
198 void vcpu_args_set(struct kvm_vm *vm, uint32_t vcpuid, unsigned int num, ...);
199
200 void vcpu_sregs_get(struct kvm_vm *vm, uint32_t vcpuid,
201 struct kvm_sregs *sregs);
202 void vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid,
203 struct kvm_sregs *sregs);
204 int _vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid,
205 struct kvm_sregs *sregs);
206 void vcpu_fpu_get(struct kvm_vm *vm, uint32_t vcpuid,
207 struct kvm_fpu *fpu);
208 void vcpu_fpu_set(struct kvm_vm *vm, uint32_t vcpuid,
209 struct kvm_fpu *fpu);
210 void vcpu_get_reg(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_one_reg *reg);
211 void vcpu_set_reg(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_one_reg *reg);
212 #ifdef __KVM_HAVE_VCPU_EVENTS
213 void vcpu_events_get(struct kvm_vm *vm, uint32_t vcpuid,
214 struct kvm_vcpu_events *events);
215 void vcpu_events_set(struct kvm_vm *vm, uint32_t vcpuid,
216 struct kvm_vcpu_events *events);
217 #endif
218 #ifdef __x86_64__
219 void vcpu_nested_state_get(struct kvm_vm *vm, uint32_t vcpuid,
220 struct kvm_nested_state *state);
221 int vcpu_nested_state_set(struct kvm_vm *vm, uint32_t vcpuid,
222 struct kvm_nested_state *state, bool ignore_error);
223 #endif
224 void *vcpu_map_dirty_ring(struct kvm_vm *vm, uint32_t vcpuid);
225
226 int _kvm_device_check_attr(int dev_fd, uint32_t group, uint64_t attr);
227 int kvm_device_check_attr(int dev_fd, uint32_t group, uint64_t attr);
228 int _kvm_create_device(struct kvm_vm *vm, uint64_t type, bool test, int *fd);
229 int kvm_create_device(struct kvm_vm *vm, uint64_t type, bool test);
230 int _kvm_device_access(int dev_fd, uint32_t group, uint64_t attr,
231 void *val, bool write);
232 int kvm_device_access(int dev_fd, uint32_t group, uint64_t attr,
233 void *val, bool write);
234
235 const char *exit_reason_str(unsigned int exit_reason);
236
237 void virt_pgd_alloc(struct kvm_vm *vm, uint32_t pgd_memslot);
238
239 /*
240 * VM Virtual Page Map
241 *
242 * Input Args:
243 * vm - Virtual Machine
244 * vaddr - VM Virtual Address
245 * paddr - VM Physical Address
246 * memslot - Memory region slot for new virtual translation tables
247 *
248 * Output Args: None
249 *
250 * Return: None
251 *
252 * Within @vm, creates a virtual translation for the page starting
253 * at @vaddr to the page starting at @paddr.
254 */
255 void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr,
256 uint32_t memslot);
257
258 vm_paddr_t vm_phy_page_alloc(struct kvm_vm *vm, vm_paddr_t paddr_min,
259 uint32_t memslot);
260 vm_paddr_t vm_phy_pages_alloc(struct kvm_vm *vm, size_t num,
261 vm_paddr_t paddr_min, uint32_t memslot);
262
263 /*
264 * Create a VM with reasonable defaults
265 *
266 * Input Args:
267 * vcpuid - The id of the single VCPU to add to the VM.
268 * extra_mem_pages - The number of extra pages to add (this will
269 * decide how much extra space we will need to
270 * setup the page tables using memslot 0)
271 * guest_code - The vCPU's entry point
272 *
273 * Output Args: None
274 *
275 * Return:
276 * Pointer to opaque structure that describes the created VM.
277 */
278 struct kvm_vm *vm_create_default(uint32_t vcpuid, uint64_t extra_mem_pages,
279 void *guest_code);
280
281 /* Same as vm_create_default, but can be used for more than one vcpu */
282 struct kvm_vm *vm_create_default_with_vcpus(uint32_t nr_vcpus, uint64_t extra_mem_pages,
283 uint32_t num_percpu_pages, void *guest_code,
284 uint32_t vcpuids[]);
285
286 /* Like vm_create_default_with_vcpus, but accepts mode as a parameter */
287 struct kvm_vm *vm_create_with_vcpus(enum vm_guest_mode mode, uint32_t nr_vcpus,
288 uint64_t extra_mem_pages, uint32_t num_percpu_pages,
289 void *guest_code, uint32_t vcpuids[]);
290
291 /*
292 * Adds a vCPU with reasonable defaults (e.g. a stack)
293 *
294 * Input Args:
295 * vm - Virtual Machine
296 * vcpuid - The id of the VCPU to add to the VM.
297 * guest_code - The vCPU's entry point
298 */
299 void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code);
300
301 bool vm_is_unrestricted_guest(struct kvm_vm *vm);
302
303 unsigned int vm_get_page_size(struct kvm_vm *vm);
304 unsigned int vm_get_page_shift(struct kvm_vm *vm);
305 unsigned int vm_get_max_gfn(struct kvm_vm *vm);
306 int vm_get_fd(struct kvm_vm *vm);
307
308 unsigned int vm_calc_num_guest_pages(enum vm_guest_mode mode, size_t size);
309 unsigned int vm_num_host_pages(enum vm_guest_mode mode, unsigned int num_guest_pages);
310 unsigned int vm_num_guest_pages(enum vm_guest_mode mode, unsigned int num_host_pages);
311 static inline unsigned int
vm_adjust_num_guest_pages(enum vm_guest_mode mode,unsigned int num_guest_pages)312 vm_adjust_num_guest_pages(enum vm_guest_mode mode, unsigned int num_guest_pages)
313 {
314 unsigned int n;
315 n = vm_num_guest_pages(mode, vm_num_host_pages(mode, num_guest_pages));
316 #ifdef __s390x__
317 /* s390 requires 1M aligned guest sizes */
318 n = (n + 255) & ~255;
319 #endif
320 return n;
321 }
322
323 struct kvm_userspace_memory_region *
324 kvm_userspace_memory_region_find(struct kvm_vm *vm, uint64_t start,
325 uint64_t end);
326
327 struct kvm_dirty_log *
328 allocate_kvm_dirty_log(struct kvm_userspace_memory_region *region);
329
330 int vm_create_device(struct kvm_vm *vm, struct kvm_create_device *cd);
331
332 #define sync_global_to_guest(vm, g) ({ \
333 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \
334 memcpy(_p, &(g), sizeof(g)); \
335 })
336
337 #define sync_global_from_guest(vm, g) ({ \
338 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \
339 memcpy(&(g), _p, sizeof(g)); \
340 })
341
342 void assert_on_unhandled_exception(struct kvm_vm *vm, uint32_t vcpuid);
343
344 /* Common ucalls */
345 enum {
346 UCALL_NONE,
347 UCALL_SYNC,
348 UCALL_ABORT,
349 UCALL_DONE,
350 };
351
352 #define UCALL_MAX_ARGS 6
353
354 struct ucall {
355 uint64_t cmd;
356 uint64_t args[UCALL_MAX_ARGS];
357 };
358
359 void ucall_init(struct kvm_vm *vm, void *arg);
360 void ucall_uninit(struct kvm_vm *vm);
361 void ucall(uint64_t cmd, int nargs, ...);
362 uint64_t get_ucall(struct kvm_vm *vm, uint32_t vcpu_id, struct ucall *uc);
363
364 #define GUEST_SYNC_ARGS(stage, arg1, arg2, arg3, arg4) \
365 ucall(UCALL_SYNC, 6, "hello", stage, arg1, arg2, arg3, arg4)
366 #define GUEST_SYNC(stage) ucall(UCALL_SYNC, 2, "hello", stage)
367 #define GUEST_DONE() ucall(UCALL_DONE, 0)
368 #define __GUEST_ASSERT(_condition, _nargs, _args...) do { \
369 if (!(_condition)) \
370 ucall(UCALL_ABORT, 2 + _nargs, \
371 "Failed guest assert: " \
372 #_condition, __LINE__, _args); \
373 } while (0)
374
375 #define GUEST_ASSERT(_condition) \
376 __GUEST_ASSERT((_condition), 0, 0)
377
378 #define GUEST_ASSERT_1(_condition, arg1) \
379 __GUEST_ASSERT((_condition), 1, (arg1))
380
381 #define GUEST_ASSERT_2(_condition, arg1, arg2) \
382 __GUEST_ASSERT((_condition), 2, (arg1), (arg2))
383
384 #define GUEST_ASSERT_3(_condition, arg1, arg2, arg3) \
385 __GUEST_ASSERT((_condition), 3, (arg1), (arg2), (arg3))
386
387 #define GUEST_ASSERT_4(_condition, arg1, arg2, arg3, arg4) \
388 __GUEST_ASSERT((_condition), 4, (arg1), (arg2), (arg3), (arg4))
389
390 #endif /* SELFTEST_KVM_UTIL_H */
391