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 /* Minimum allocated guest virtual and physical addresses */ 28 #define KVM_UTIL_MIN_VADDR 0x2000 29 30 #define DEFAULT_GUEST_PHY_PAGES 512 31 #define DEFAULT_GUEST_STACK_VADDR_MIN 0xab6000 32 #define DEFAULT_STACK_PGS 5 33 34 enum vm_guest_mode { 35 VM_MODE_P52V48_4K, 36 VM_MODE_P52V48_64K, 37 VM_MODE_P48V48_4K, 38 VM_MODE_P48V48_64K, 39 VM_MODE_P40V48_4K, 40 VM_MODE_P40V48_64K, 41 NUM_VM_MODES, 42 }; 43 44 #define vm_guest_mode_string(m) vm_guest_mode_string[m] 45 extern const char * const vm_guest_mode_string[]; 46 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); 54 int vm_enable_cap(struct kvm_vm *vm, struct kvm_enable_cap *cap); 55 56 struct kvm_vm *vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm); 57 struct kvm_vm *_vm_create(enum vm_guest_mode mode, uint64_t phy_pages, 58 int perm, unsigned long type); 59 void kvm_vm_free(struct kvm_vm *vmp); 60 void kvm_vm_restart(struct kvm_vm *vmp, int perm); 61 void kvm_vm_release(struct kvm_vm *vmp); 62 void kvm_vm_get_dirty_log(struct kvm_vm *vm, int slot, void *log); 63 void kvm_vm_clear_dirty_log(struct kvm_vm *vm, int slot, void *log, 64 uint64_t first_page, uint32_t num_pages); 65 66 int kvm_memcmp_hva_gva(void *hva, struct kvm_vm *vm, const vm_vaddr_t gva, 67 size_t len); 68 69 void kvm_vm_elf_load(struct kvm_vm *vm, const char *filename, 70 uint32_t data_memslot, uint32_t pgd_memslot); 71 72 void vm_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent); 73 void vcpu_dump(FILE *stream, struct kvm_vm *vm, uint32_t vcpuid, 74 uint8_t indent); 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 83 void vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, 84 void *arg); 85 int _vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, 86 void *arg); 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); 89 void vm_vcpu_add(struct kvm_vm *vm, uint32_t vcpuid); 90 vm_vaddr_t vm_vaddr_alloc(struct kvm_vm *vm, size_t sz, vm_vaddr_t vaddr_min, 91 uint32_t data_memslot, uint32_t pgd_memslot); 92 void virt_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, 93 size_t size, uint32_t pgd_memslot); 94 void *addr_gpa2hva(struct kvm_vm *vm, vm_paddr_t gpa); 95 void *addr_gva2hva(struct kvm_vm *vm, vm_vaddr_t gva); 96 vm_paddr_t addr_hva2gpa(struct kvm_vm *vm, void *hva); 97 vm_paddr_t addr_gva2gpa(struct kvm_vm *vm, vm_vaddr_t gva); 98 99 struct kvm_run *vcpu_state(struct kvm_vm *vm, uint32_t vcpuid); 100 void vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); 101 int _vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); 102 void vcpu_run_complete_io(struct kvm_vm *vm, uint32_t vcpuid); 103 void vcpu_set_mp_state(struct kvm_vm *vm, uint32_t vcpuid, 104 struct kvm_mp_state *mp_state); 105 void vcpu_regs_get(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs); 106 void vcpu_regs_set(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs); 107 void vcpu_args_set(struct kvm_vm *vm, uint32_t vcpuid, unsigned int num, ...); 108 void vcpu_sregs_get(struct kvm_vm *vm, uint32_t vcpuid, 109 struct kvm_sregs *sregs); 110 void vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid, 111 struct kvm_sregs *sregs); 112 int _vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid, 113 struct kvm_sregs *sregs); 114 void vcpu_events_get(struct kvm_vm *vm, uint32_t vcpuid, 115 struct kvm_vcpu_events *events); 116 void vcpu_events_set(struct kvm_vm *vm, uint32_t vcpuid, 117 struct kvm_vcpu_events *events); 118 #ifdef __x86_64__ 119 void vcpu_nested_state_get(struct kvm_vm *vm, uint32_t vcpuid, 120 struct kvm_nested_state *state); 121 int vcpu_nested_state_set(struct kvm_vm *vm, uint32_t vcpuid, 122 struct kvm_nested_state *state, bool ignore_error); 123 #endif 124 125 const char *exit_reason_str(unsigned int exit_reason); 126 127 void virt_pgd_alloc(struct kvm_vm *vm, uint32_t pgd_memslot); 128 void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, 129 uint32_t pgd_memslot); 130 vm_paddr_t vm_phy_page_alloc(struct kvm_vm *vm, vm_paddr_t paddr_min, 131 uint32_t memslot); 132 vm_paddr_t vm_phy_pages_alloc(struct kvm_vm *vm, size_t num, 133 vm_paddr_t paddr_min, uint32_t memslot); 134 135 struct kvm_vm *vm_create_default(uint32_t vcpuid, uint64_t extra_mem_size, 136 void *guest_code); 137 void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code); 138 139 bool vm_is_unrestricted_guest(struct kvm_vm *vm); 140 141 struct kvm_userspace_memory_region * 142 kvm_userspace_memory_region_find(struct kvm_vm *vm, uint64_t start, 143 uint64_t end); 144 145 struct kvm_dirty_log * 146 allocate_kvm_dirty_log(struct kvm_userspace_memory_region *region); 147 148 int vm_create_device(struct kvm_vm *vm, struct kvm_create_device *cd); 149 150 #define sync_global_to_guest(vm, g) ({ \ 151 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ 152 memcpy(_p, &(g), sizeof(g)); \ 153 }) 154 155 #define sync_global_from_guest(vm, g) ({ \ 156 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ 157 memcpy(&(g), _p, sizeof(g)); \ 158 }) 159 160 /* ucall implementation types */ 161 typedef enum { 162 UCALL_PIO, 163 UCALL_MMIO, 164 } ucall_type_t; 165 166 /* Common ucalls */ 167 enum { 168 UCALL_NONE, 169 UCALL_SYNC, 170 UCALL_ABORT, 171 UCALL_DONE, 172 }; 173 174 #define UCALL_MAX_ARGS 6 175 176 struct ucall { 177 uint64_t cmd; 178 uint64_t args[UCALL_MAX_ARGS]; 179 }; 180 181 void ucall_init(struct kvm_vm *vm, ucall_type_t type, void *arg); 182 void ucall_uninit(struct kvm_vm *vm); 183 void ucall(uint64_t cmd, int nargs, ...); 184 uint64_t get_ucall(struct kvm_vm *vm, uint32_t vcpu_id, struct ucall *uc); 185 186 #define GUEST_SYNC(stage) ucall(UCALL_SYNC, 2, "hello", stage) 187 #define GUEST_DONE() ucall(UCALL_DONE, 0) 188 #define GUEST_ASSERT(_condition) do { \ 189 if (!(_condition)) \ 190 ucall(UCALL_ABORT, 2, \ 191 "Failed guest assert: " \ 192 #_condition, __LINE__); \ 193 } while (0) 194 195 #endif /* SELFTEST_KVM_UTIL_H */ 196