1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * tools/testing/selftests/kvm/include/kvm_util.h
5 * Copyright (C) 2018, Google LLC.
7 #ifndef SELFTEST_KVM_UTIL_H
8 #define SELFTEST_KVM_UTIL_H
10 #include "test_util.h"
13 #include "linux/list.h"
14 #include "linux/kvm.h"
15 #include <sys/ioctl.h>
17 #include "sparsebit.h"
19 #define KVM_DEV_PATH "/dev/kvm"
20 #define KVM_MAX_VCPUS 512
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.
28 typedef uint64_t vm_paddr_t; /* Virtual Machine (Guest) physical address */
29 typedef uint64_t vm_vaddr_t; /* Virtual Machine (Guest) virtual address */
31 /* Minimum allocated guest virtual and physical addresses */
32 #define KVM_UTIL_MIN_VADDR 0x2000
33 #define KVM_GUEST_PAGE_TABLE_MIN_PADDR 0x180000
35 #define DEFAULT_GUEST_PHY_PAGES 512
36 #define DEFAULT_GUEST_STACK_VADDR_MIN 0xab6000
37 #define DEFAULT_STACK_PGS 5
46 VM_MODE_PXXV48_4K, /* For 48bits VA but ANY bits PA */
52 #if defined(__aarch64__)
54 #define VM_MODE_DEFAULT VM_MODE_P40V48_4K
55 #define MIN_PAGE_SHIFT 12U
56 #define ptes_per_page(page_size) ((page_size) / 8)
58 #elif defined(__x86_64__)
60 #define VM_MODE_DEFAULT VM_MODE_PXXV48_4K
61 #define MIN_PAGE_SHIFT 12U
62 #define ptes_per_page(page_size) ((page_size) / 8)
64 #elif defined(__s390x__)
66 #define VM_MODE_DEFAULT VM_MODE_P44V64_4K
67 #define MIN_PAGE_SHIFT 12U
68 #define ptes_per_page(page_size) ((page_size) / 16)
72 #define MIN_PAGE_SIZE (1U << MIN_PAGE_SHIFT)
73 #define PTES_PER_MIN_PAGE ptes_per_page(MIN_PAGE_SIZE)
75 struct vm_guest_mode_params {
78 unsigned int page_size;
79 unsigned int page_shift;
81 extern const struct vm_guest_mode_params vm_guest_mode_params[];
83 int open_kvm_dev_path_or_exit(void);
84 int kvm_check_cap(long cap);
85 int vm_enable_cap(struct kvm_vm *vm, struct kvm_enable_cap *cap);
86 int vcpu_enable_cap(struct kvm_vm *vm, uint32_t vcpu_id,
87 struct kvm_enable_cap *cap);
88 void vm_enable_dirty_ring(struct kvm_vm *vm, uint32_t ring_size);
89 const char *vm_guest_mode_string(uint32_t i);
91 struct kvm_vm *vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm);
92 void kvm_vm_free(struct kvm_vm *vmp);
93 void kvm_vm_restart(struct kvm_vm *vmp, int perm);
94 void kvm_vm_release(struct kvm_vm *vmp);
95 void kvm_vm_get_dirty_log(struct kvm_vm *vm, int slot, void *log);
96 void kvm_vm_clear_dirty_log(struct kvm_vm *vm, int slot, void *log,
97 uint64_t first_page, uint32_t num_pages);
98 uint32_t kvm_vm_reset_dirty_ring(struct kvm_vm *vm);
100 int kvm_memcmp_hva_gva(void *hva, struct kvm_vm *vm, const vm_vaddr_t gva,
103 void kvm_vm_elf_load(struct kvm_vm *vm, const char *filename);
105 void vm_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent);
111 * stream - Output FILE stream
112 * vm - Virtual Machine
114 * indent - Left margin indent amount
120 * Dumps the current state of the VCPU specified by @vcpuid, within the VM
121 * given by @vm, to the FILE stream given by @stream.
123 void vcpu_dump(FILE *stream, struct kvm_vm *vm, uint32_t vcpuid,
126 void vm_create_irqchip(struct kvm_vm *vm);
128 void vm_userspace_mem_region_add(struct kvm_vm *vm,
129 enum vm_mem_backing_src_type src_type,
130 uint64_t guest_paddr, uint32_t slot, uint64_t npages,
133 void vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl,
135 int _vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl,
137 void vm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg);
138 int _vm_ioctl(struct kvm_vm *vm, unsigned long cmd, void *arg);
139 void kvm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg);
140 int _kvm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg);
141 void vm_mem_region_set_flags(struct kvm_vm *vm, uint32_t slot, uint32_t flags);
142 void vm_mem_region_move(struct kvm_vm *vm, uint32_t slot, uint64_t new_gpa);
143 void vm_mem_region_delete(struct kvm_vm *vm, uint32_t slot);
144 void vm_vcpu_add(struct kvm_vm *vm, uint32_t vcpuid);
145 vm_vaddr_t vm_vaddr_alloc(struct kvm_vm *vm, size_t sz, vm_vaddr_t vaddr_min);
146 vm_vaddr_t vm_vaddr_alloc_pages(struct kvm_vm *vm, int nr_pages);
147 vm_vaddr_t vm_vaddr_alloc_page(struct kvm_vm *vm);
149 void virt_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr,
150 unsigned int npages);
151 void *addr_gpa2hva(struct kvm_vm *vm, vm_paddr_t gpa);
152 void *addr_gva2hva(struct kvm_vm *vm, vm_vaddr_t gva);
153 vm_paddr_t addr_hva2gpa(struct kvm_vm *vm, void *hva);
154 void *addr_gpa2alias(struct kvm_vm *vm, vm_paddr_t gpa);
157 * Address Guest Virtual to Guest Physical
160 * vm - Virtual Machine
161 * gva - VM virtual address
166 * Equivalent VM physical address
168 * Returns the VM physical address of the translated VM virtual
169 * address given by @gva.
171 vm_paddr_t addr_gva2gpa(struct kvm_vm *vm, vm_vaddr_t gva);
173 struct kvm_run *vcpu_state(struct kvm_vm *vm, uint32_t vcpuid);
174 void vcpu_run(struct kvm_vm *vm, uint32_t vcpuid);
175 int _vcpu_run(struct kvm_vm *vm, uint32_t vcpuid);
176 int vcpu_get_fd(struct kvm_vm *vm, uint32_t vcpuid);
177 void vcpu_run_complete_io(struct kvm_vm *vm, uint32_t vcpuid);
178 void vcpu_set_guest_debug(struct kvm_vm *vm, uint32_t vcpuid,
179 struct kvm_guest_debug *debug);
180 void vcpu_set_mp_state(struct kvm_vm *vm, uint32_t vcpuid,
181 struct kvm_mp_state *mp_state);
182 struct kvm_reg_list *vcpu_get_reg_list(struct kvm_vm *vm, uint32_t vcpuid);
183 void vcpu_regs_get(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs);
184 void vcpu_regs_set(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs);
190 * vm - Virtual Machine
192 * num - number of arguments
193 * ... - arguments, each of type uint64_t
199 * Sets the first @num function input registers of the VCPU with @vcpuid,
200 * per the C calling convention of the architecture, to the values given
201 * as variable args. Each of the variable args is expected to be of type
202 * uint64_t. The maximum @num can be is specific to the architecture.
204 void vcpu_args_set(struct kvm_vm *vm, uint32_t vcpuid, unsigned int num, ...);
206 void vcpu_sregs_get(struct kvm_vm *vm, uint32_t vcpuid,
207 struct kvm_sregs *sregs);
208 void vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid,
209 struct kvm_sregs *sregs);
210 int _vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid,
211 struct kvm_sregs *sregs);
212 void vcpu_fpu_get(struct kvm_vm *vm, uint32_t vcpuid,
213 struct kvm_fpu *fpu);
214 void vcpu_fpu_set(struct kvm_vm *vm, uint32_t vcpuid,
215 struct kvm_fpu *fpu);
216 void vcpu_get_reg(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_one_reg *reg);
217 void vcpu_set_reg(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_one_reg *reg);
218 #ifdef __KVM_HAVE_VCPU_EVENTS
219 void vcpu_events_get(struct kvm_vm *vm, uint32_t vcpuid,
220 struct kvm_vcpu_events *events);
221 void vcpu_events_set(struct kvm_vm *vm, uint32_t vcpuid,
222 struct kvm_vcpu_events *events);
225 void vcpu_nested_state_get(struct kvm_vm *vm, uint32_t vcpuid,
226 struct kvm_nested_state *state);
227 int vcpu_nested_state_set(struct kvm_vm *vm, uint32_t vcpuid,
228 struct kvm_nested_state *state, bool ignore_error);
230 void *vcpu_map_dirty_ring(struct kvm_vm *vm, uint32_t vcpuid);
232 int _kvm_device_check_attr(int dev_fd, uint32_t group, uint64_t attr);
233 int kvm_device_check_attr(int dev_fd, uint32_t group, uint64_t attr);
234 int _kvm_create_device(struct kvm_vm *vm, uint64_t type, bool test, int *fd);
235 int kvm_create_device(struct kvm_vm *vm, uint64_t type, bool test);
236 int _kvm_device_access(int dev_fd, uint32_t group, uint64_t attr,
237 void *val, bool write);
238 int kvm_device_access(int dev_fd, uint32_t group, uint64_t attr,
239 void *val, bool write);
241 const char *exit_reason_str(unsigned int exit_reason);
243 void virt_pgd_alloc(struct kvm_vm *vm);
246 * VM Virtual Page Map
249 * vm - Virtual Machine
250 * vaddr - VM Virtual Address
251 * paddr - VM Physical Address
252 * memslot - Memory region slot for new virtual translation tables
258 * Within @vm, creates a virtual translation for the page starting
259 * at @vaddr to the page starting at @paddr.
261 void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr);
263 vm_paddr_t vm_phy_page_alloc(struct kvm_vm *vm, vm_paddr_t paddr_min,
265 vm_paddr_t vm_phy_pages_alloc(struct kvm_vm *vm, size_t num,
266 vm_paddr_t paddr_min, uint32_t memslot);
267 vm_paddr_t vm_alloc_page_table(struct kvm_vm *vm);
270 * Create a VM with reasonable defaults
273 * vcpuid - The id of the single VCPU to add to the VM.
274 * extra_mem_pages - The number of extra pages to add (this will
275 * decide how much extra space we will need to
276 * setup the page tables using memslot 0)
277 * guest_code - The vCPU's entry point
282 * Pointer to opaque structure that describes the created VM.
284 struct kvm_vm *vm_create_default(uint32_t vcpuid, uint64_t extra_mem_pages,
287 /* Same as vm_create_default, but can be used for more than one vcpu */
288 struct kvm_vm *vm_create_default_with_vcpus(uint32_t nr_vcpus, uint64_t extra_mem_pages,
289 uint32_t num_percpu_pages, void *guest_code,
292 /* Like vm_create_default_with_vcpus, but accepts mode and slot0 memory as a parameter */
293 struct kvm_vm *vm_create_with_vcpus(enum vm_guest_mode mode, uint32_t nr_vcpus,
294 uint64_t slot0_mem_pages, uint64_t extra_mem_pages,
295 uint32_t num_percpu_pages, void *guest_code,
299 * Adds a vCPU with reasonable defaults (e.g. a stack)
302 * vm - Virtual Machine
303 * vcpuid - The id of the VCPU to add to the VM.
304 * guest_code - The vCPU's entry point
306 void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code);
308 bool vm_is_unrestricted_guest(struct kvm_vm *vm);
310 unsigned int vm_get_page_size(struct kvm_vm *vm);
311 unsigned int vm_get_page_shift(struct kvm_vm *vm);
312 uint64_t vm_get_max_gfn(struct kvm_vm *vm);
313 int vm_get_fd(struct kvm_vm *vm);
315 unsigned int vm_calc_num_guest_pages(enum vm_guest_mode mode, size_t size);
316 unsigned int vm_num_host_pages(enum vm_guest_mode mode, unsigned int num_guest_pages);
317 unsigned int vm_num_guest_pages(enum vm_guest_mode mode, unsigned int num_host_pages);
318 static inline unsigned int
319 vm_adjust_num_guest_pages(enum vm_guest_mode mode, unsigned int num_guest_pages)
322 n = vm_num_guest_pages(mode, vm_num_host_pages(mode, num_guest_pages));
324 /* s390 requires 1M aligned guest sizes */
325 n = (n + 255) & ~255;
330 struct kvm_userspace_memory_region *
331 kvm_userspace_memory_region_find(struct kvm_vm *vm, uint64_t start,
334 struct kvm_dirty_log *
335 allocate_kvm_dirty_log(struct kvm_userspace_memory_region *region);
337 int vm_create_device(struct kvm_vm *vm, struct kvm_create_device *cd);
339 #define sync_global_to_guest(vm, g) ({ \
340 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \
341 memcpy(_p, &(g), sizeof(g)); \
344 #define sync_global_from_guest(vm, g) ({ \
345 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \
346 memcpy(&(g), _p, sizeof(g)); \
349 void assert_on_unhandled_exception(struct kvm_vm *vm, uint32_t vcpuid);
360 #define UCALL_MAX_ARGS 6
364 uint64_t args[UCALL_MAX_ARGS];
367 void ucall_init(struct kvm_vm *vm, void *arg);
368 void ucall_uninit(struct kvm_vm *vm);
369 void ucall(uint64_t cmd, int nargs, ...);
370 uint64_t get_ucall(struct kvm_vm *vm, uint32_t vcpu_id, struct ucall *uc);
372 #define GUEST_SYNC_ARGS(stage, arg1, arg2, arg3, arg4) \
373 ucall(UCALL_SYNC, 6, "hello", stage, arg1, arg2, arg3, arg4)
374 #define GUEST_SYNC(stage) ucall(UCALL_SYNC, 2, "hello", stage)
375 #define GUEST_DONE() ucall(UCALL_DONE, 0)
376 #define __GUEST_ASSERT(_condition, _condstr, _nargs, _args...) do { \
378 ucall(UCALL_ABORT, 2 + _nargs, \
379 "Failed guest assert: " \
380 _condstr, __LINE__, _args); \
383 #define GUEST_ASSERT(_condition) \
384 __GUEST_ASSERT(_condition, #_condition, 0, 0)
386 #define GUEST_ASSERT_1(_condition, arg1) \
387 __GUEST_ASSERT(_condition, #_condition, 1, (arg1))
389 #define GUEST_ASSERT_2(_condition, arg1, arg2) \
390 __GUEST_ASSERT(_condition, #_condition, 2, (arg1), (arg2))
392 #define GUEST_ASSERT_3(_condition, arg1, arg2, arg3) \
393 __GUEST_ASSERT(_condition, #_condition, 3, (arg1), (arg2), (arg3))
395 #define GUEST_ASSERT_4(_condition, arg1, arg2, arg3, arg4) \
396 __GUEST_ASSERT(_condition, #_condition, 4, (arg1), (arg2), (arg3), (arg4))
398 #define GUEST_ASSERT_EQ(a, b) __GUEST_ASSERT((a) == (b), #a " == " #b, 2, a, b)
400 int vm_get_stats_fd(struct kvm_vm *vm);
401 int vcpu_get_stats_fd(struct kvm_vm *vm, uint32_t vcpuid);
403 #endif /* SELFTEST_KVM_UTIL_H */