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/kvm.h" 14 #include <sys/ioctl.h> 15 16 #include "sparsebit.h" 17 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 #ifndef NDEBUG 28 #define DEBUG(...) printf(__VA_ARGS__); 29 #else 30 #define DEBUG(...) 31 #endif 32 33 /* Minimum allocated guest virtual and physical addresses */ 34 #define KVM_UTIL_MIN_VADDR 0x2000 35 36 #define DEFAULT_GUEST_PHY_PAGES 512 37 #define DEFAULT_GUEST_STACK_VADDR_MIN 0xab6000 38 #define DEFAULT_STACK_PGS 5 39 40 enum vm_guest_mode { 41 VM_MODE_P52V48_4K, 42 VM_MODE_P52V48_64K, 43 VM_MODE_P48V48_4K, 44 VM_MODE_P48V48_64K, 45 VM_MODE_P40V48_4K, 46 VM_MODE_P40V48_64K, 47 VM_MODE_PXXV48_4K, /* For 48bits VA but ANY bits PA */ 48 NUM_VM_MODES, 49 }; 50 51 #if defined(__aarch64__) 52 #define VM_MODE_DEFAULT VM_MODE_P40V48_4K 53 #elif defined(__x86_64__) 54 #define VM_MODE_DEFAULT VM_MODE_PXXV48_4K 55 #else 56 #define VM_MODE_DEFAULT VM_MODE_P52V48_4K 57 #endif 58 59 #define vm_guest_mode_string(m) vm_guest_mode_string[m] 60 extern const char * const vm_guest_mode_string[]; 61 62 enum vm_mem_backing_src_type { 63 VM_MEM_SRC_ANONYMOUS, 64 VM_MEM_SRC_ANONYMOUS_THP, 65 VM_MEM_SRC_ANONYMOUS_HUGETLB, 66 }; 67 68 int kvm_check_cap(long cap); 69 int vm_enable_cap(struct kvm_vm *vm, struct kvm_enable_cap *cap); 70 71 struct kvm_vm *vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm); 72 struct kvm_vm *_vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm); 73 void kvm_vm_free(struct kvm_vm *vmp); 74 void kvm_vm_restart(struct kvm_vm *vmp, int perm); 75 void kvm_vm_release(struct kvm_vm *vmp); 76 void kvm_vm_get_dirty_log(struct kvm_vm *vm, int slot, void *log); 77 void kvm_vm_clear_dirty_log(struct kvm_vm *vm, int slot, void *log, 78 uint64_t first_page, uint32_t num_pages); 79 80 int kvm_memcmp_hva_gva(void *hva, struct kvm_vm *vm, const vm_vaddr_t gva, 81 size_t len); 82 83 void kvm_vm_elf_load(struct kvm_vm *vm, const char *filename, 84 uint32_t data_memslot, uint32_t pgd_memslot); 85 86 void vm_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent); 87 void vcpu_dump(FILE *stream, struct kvm_vm *vm, uint32_t vcpuid, 88 uint8_t indent); 89 90 void vm_create_irqchip(struct kvm_vm *vm); 91 92 void vm_userspace_mem_region_add(struct kvm_vm *vm, 93 enum vm_mem_backing_src_type src_type, 94 uint64_t guest_paddr, uint32_t slot, uint64_t npages, 95 uint32_t flags); 96 97 void vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, 98 void *arg); 99 int _vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, 100 void *arg); 101 void vm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg); 102 void vm_mem_region_set_flags(struct kvm_vm *vm, uint32_t slot, uint32_t flags); 103 void vm_vcpu_add(struct kvm_vm *vm, uint32_t vcpuid); 104 vm_vaddr_t vm_vaddr_alloc(struct kvm_vm *vm, size_t sz, vm_vaddr_t vaddr_min, 105 uint32_t data_memslot, uint32_t pgd_memslot); 106 void virt_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, 107 size_t size, uint32_t pgd_memslot); 108 void *addr_gpa2hva(struct kvm_vm *vm, vm_paddr_t gpa); 109 void *addr_gva2hva(struct kvm_vm *vm, vm_vaddr_t gva); 110 vm_paddr_t addr_hva2gpa(struct kvm_vm *vm, void *hva); 111 vm_paddr_t addr_gva2gpa(struct kvm_vm *vm, vm_vaddr_t gva); 112 113 struct kvm_run *vcpu_state(struct kvm_vm *vm, uint32_t vcpuid); 114 void vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); 115 int _vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); 116 void vcpu_run_complete_io(struct kvm_vm *vm, uint32_t vcpuid); 117 void vcpu_set_mp_state(struct kvm_vm *vm, uint32_t vcpuid, 118 struct kvm_mp_state *mp_state); 119 void vcpu_regs_get(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs); 120 void vcpu_regs_set(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs); 121 void vcpu_args_set(struct kvm_vm *vm, uint32_t vcpuid, unsigned int num, ...); 122 void vcpu_sregs_get(struct kvm_vm *vm, uint32_t vcpuid, 123 struct kvm_sregs *sregs); 124 void vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid, 125 struct kvm_sregs *sregs); 126 int _vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid, 127 struct kvm_sregs *sregs); 128 void vcpu_fpu_get(struct kvm_vm *vm, uint32_t vcpuid, 129 struct kvm_fpu *fpu); 130 void vcpu_fpu_set(struct kvm_vm *vm, uint32_t vcpuid, 131 struct kvm_fpu *fpu); 132 void vcpu_get_reg(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_one_reg *reg); 133 void vcpu_set_reg(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_one_reg *reg); 134 #ifdef __KVM_HAVE_VCPU_EVENTS 135 void vcpu_events_get(struct kvm_vm *vm, uint32_t vcpuid, 136 struct kvm_vcpu_events *events); 137 void vcpu_events_set(struct kvm_vm *vm, uint32_t vcpuid, 138 struct kvm_vcpu_events *events); 139 #endif 140 #ifdef __x86_64__ 141 void vcpu_nested_state_get(struct kvm_vm *vm, uint32_t vcpuid, 142 struct kvm_nested_state *state); 143 int vcpu_nested_state_set(struct kvm_vm *vm, uint32_t vcpuid, 144 struct kvm_nested_state *state, bool ignore_error); 145 #endif 146 147 const char *exit_reason_str(unsigned int exit_reason); 148 149 void virt_pgd_alloc(struct kvm_vm *vm, uint32_t pgd_memslot); 150 void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, 151 uint32_t pgd_memslot); 152 vm_paddr_t vm_phy_page_alloc(struct kvm_vm *vm, vm_paddr_t paddr_min, 153 uint32_t memslot); 154 vm_paddr_t vm_phy_pages_alloc(struct kvm_vm *vm, size_t num, 155 vm_paddr_t paddr_min, uint32_t memslot); 156 157 struct kvm_vm *vm_create_default(uint32_t vcpuid, uint64_t extra_mem_size, 158 void *guest_code); 159 void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code); 160 161 bool vm_is_unrestricted_guest(struct kvm_vm *vm); 162 163 unsigned int vm_get_page_size(struct kvm_vm *vm); 164 unsigned int vm_get_page_shift(struct kvm_vm *vm); 165 unsigned int vm_get_max_gfn(struct kvm_vm *vm); 166 167 struct kvm_userspace_memory_region * 168 kvm_userspace_memory_region_find(struct kvm_vm *vm, uint64_t start, 169 uint64_t end); 170 171 struct kvm_dirty_log * 172 allocate_kvm_dirty_log(struct kvm_userspace_memory_region *region); 173 174 int vm_create_device(struct kvm_vm *vm, struct kvm_create_device *cd); 175 176 #define sync_global_to_guest(vm, g) ({ \ 177 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ 178 memcpy(_p, &(g), sizeof(g)); \ 179 }) 180 181 #define sync_global_from_guest(vm, g) ({ \ 182 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ 183 memcpy(&(g), _p, sizeof(g)); \ 184 }) 185 186 /* Common ucalls */ 187 enum { 188 UCALL_NONE, 189 UCALL_SYNC, 190 UCALL_ABORT, 191 UCALL_DONE, 192 }; 193 194 #define UCALL_MAX_ARGS 6 195 196 struct ucall { 197 uint64_t cmd; 198 uint64_t args[UCALL_MAX_ARGS]; 199 }; 200 201 void ucall_init(struct kvm_vm *vm, void *arg); 202 void ucall_uninit(struct kvm_vm *vm); 203 void ucall(uint64_t cmd, int nargs, ...); 204 uint64_t get_ucall(struct kvm_vm *vm, uint32_t vcpu_id, struct ucall *uc); 205 206 #define GUEST_SYNC(stage) ucall(UCALL_SYNC, 2, "hello", stage) 207 #define GUEST_DONE() ucall(UCALL_DONE, 0) 208 #define GUEST_ASSERT(_condition) do { \ 209 if (!(_condition)) \ 210 ucall(UCALL_ABORT, 2, \ 211 "Failed guest assert: " \ 212 #_condition, __LINE__); \ 213 } while (0) 214 215 #endif /* SELFTEST_KVM_UTIL_H */ 216