1 /* 2 * tools/testing/selftests/kvm/include/kvm_util.h 3 * 4 * Copyright (C) 2018, Google LLC. 5 * 6 * This work is licensed under the terms of the GNU GPL, version 2. 7 * 8 */ 9 #ifndef SELFTEST_KVM_UTIL_H 10 #define SELFTEST_KVM_UTIL_H 1 11 12 #include "test_util.h" 13 14 #include "asm/kvm.h" 15 #include "linux/kvm.h" 16 #include <sys/ioctl.h> 17 18 #include "sparsebit.h" 19 20 /* 21 * Memslots can't cover the gfn starting at this gpa otherwise vCPUs can't be 22 * created. Only applies to VMs using EPT. 23 */ 24 #define KVM_DEFAULT_IDENTITY_MAP_ADDRESS 0xfffbc000ul 25 26 27 /* Callers of kvm_util only have an incomplete/opaque description of the 28 * structure kvm_util is using to maintain the state of a VM. 29 */ 30 struct kvm_vm; 31 32 typedef uint64_t vm_paddr_t; /* Virtual Machine (Guest) physical address */ 33 typedef uint64_t vm_vaddr_t; /* Virtual Machine (Guest) virtual address */ 34 35 /* Minimum allocated guest virtual and physical addresses */ 36 #define KVM_UTIL_MIN_VADDR 0x2000 37 38 #define DEFAULT_GUEST_PHY_PAGES 512 39 #define DEFAULT_GUEST_STACK_VADDR_MIN 0xab6000 40 #define DEFAULT_STACK_PGS 5 41 42 enum vm_guest_mode { 43 VM_MODE_FLAT48PG, 44 }; 45 46 enum vm_mem_backing_src_type { 47 VM_MEM_SRC_ANONYMOUS, 48 VM_MEM_SRC_ANONYMOUS_THP, 49 VM_MEM_SRC_ANONYMOUS_HUGETLB, 50 }; 51 52 int kvm_check_cap(long cap); 53 54 struct kvm_vm *vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm); 55 void kvm_vm_free(struct kvm_vm *vmp); 56 void kvm_vm_restart(struct kvm_vm *vmp, int perm); 57 void kvm_vm_release(struct kvm_vm *vmp); 58 void kvm_vm_get_dirty_log(struct kvm_vm *vm, int slot, void *log); 59 60 int kvm_memcmp_hva_gva(void *hva, 61 struct kvm_vm *vm, const vm_vaddr_t gva, size_t len); 62 63 void kvm_vm_elf_load(struct kvm_vm *vm, const char *filename, 64 uint32_t data_memslot, uint32_t pgd_memslot); 65 66 void vm_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent); 67 void vcpu_dump(FILE *stream, struct kvm_vm *vm, 68 uint32_t vcpuid, uint8_t indent); 69 70 void vm_create_irqchip(struct kvm_vm *vm); 71 72 void vm_userspace_mem_region_add(struct kvm_vm *vm, 73 enum vm_mem_backing_src_type src_type, 74 uint64_t guest_paddr, uint32_t slot, uint64_t npages, 75 uint32_t flags); 76 77 void vcpu_ioctl(struct kvm_vm *vm, 78 uint32_t vcpuid, unsigned long ioctl, void *arg); 79 void vm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg); 80 void vm_mem_region_set_flags(struct kvm_vm *vm, uint32_t slot, uint32_t flags); 81 void vm_vcpu_add(struct kvm_vm *vm, uint32_t vcpuid, int pgd_memslot, int gdt_memslot); 82 vm_vaddr_t vm_vaddr_alloc(struct kvm_vm *vm, size_t sz, vm_vaddr_t vaddr_min, 83 uint32_t data_memslot, uint32_t pgd_memslot); 84 void virt_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, 85 size_t size, uint32_t pgd_memslot); 86 void *addr_gpa2hva(struct kvm_vm *vm, vm_paddr_t gpa); 87 void *addr_gva2hva(struct kvm_vm *vm, vm_vaddr_t gva); 88 vm_paddr_t addr_hva2gpa(struct kvm_vm *vm, void *hva); 89 vm_paddr_t addr_gva2gpa(struct kvm_vm *vm, vm_vaddr_t gva); 90 91 struct kvm_run *vcpu_state(struct kvm_vm *vm, uint32_t vcpuid); 92 void vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); 93 int _vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); 94 void vcpu_set_mp_state(struct kvm_vm *vm, uint32_t vcpuid, 95 struct kvm_mp_state *mp_state); 96 void vcpu_regs_get(struct kvm_vm *vm, 97 uint32_t vcpuid, struct kvm_regs *regs); 98 void vcpu_regs_set(struct kvm_vm *vm, 99 uint32_t vcpuid, struct kvm_regs *regs); 100 void vcpu_args_set(struct kvm_vm *vm, uint32_t vcpuid, unsigned int num, ...); 101 void vcpu_sregs_get(struct kvm_vm *vm, 102 uint32_t vcpuid, struct kvm_sregs *sregs); 103 void vcpu_sregs_set(struct kvm_vm *vm, 104 uint32_t vcpuid, struct kvm_sregs *sregs); 105 int _vcpu_sregs_set(struct kvm_vm *vm, 106 uint32_t vcpuid, struct kvm_sregs *sregs); 107 void vcpu_events_get(struct kvm_vm *vm, uint32_t vcpuid, 108 struct kvm_vcpu_events *events); 109 void vcpu_events_set(struct kvm_vm *vm, uint32_t vcpuid, 110 struct kvm_vcpu_events *events); 111 112 const char *exit_reason_str(unsigned int exit_reason); 113 114 void virt_pgd_alloc(struct kvm_vm *vm, uint32_t pgd_memslot); 115 void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, 116 uint32_t pgd_memslot); 117 vm_paddr_t vm_phy_page_alloc(struct kvm_vm *vm, 118 vm_paddr_t paddr_min, uint32_t memslot); 119 120 struct kvm_cpuid2 *kvm_get_supported_cpuid(void); 121 void vcpu_set_cpuid( 122 struct kvm_vm *vm, uint32_t vcpuid, struct kvm_cpuid2 *cpuid); 123 124 struct kvm_cpuid_entry2 * 125 kvm_get_supported_cpuid_index(uint32_t function, uint32_t index); 126 127 static inline struct kvm_cpuid_entry2 * 128 kvm_get_supported_cpuid_entry(uint32_t function) 129 { 130 return kvm_get_supported_cpuid_index(function, 0); 131 } 132 133 struct kvm_vm *vm_create_default(uint32_t vcpuid, uint64_t extra_mem_size, 134 void *guest_code); 135 void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code); 136 137 typedef void (*vmx_guest_code_t)(vm_vaddr_t vmxon_vaddr, 138 vm_paddr_t vmxon_paddr, 139 vm_vaddr_t vmcs_vaddr, 140 vm_paddr_t vmcs_paddr); 141 142 struct kvm_userspace_memory_region * 143 kvm_userspace_memory_region_find(struct kvm_vm *vm, uint64_t start, 144 uint64_t end); 145 146 struct kvm_dirty_log * 147 allocate_kvm_dirty_log(struct kvm_userspace_memory_region *region); 148 149 int vm_create_device(struct kvm_vm *vm, struct kvm_create_device *cd); 150 151 #define GUEST_PORT_SYNC 0x1000 152 #define GUEST_PORT_ABORT 0x1001 153 #define GUEST_PORT_DONE 0x1002 154 155 static inline void __exit_to_l0(uint16_t port, uint64_t arg0, uint64_t arg1) 156 { 157 __asm__ __volatile__("in %[port], %%al" 158 : 159 : [port]"d"(port), "D"(arg0), "S"(arg1) 160 : "rax"); 161 } 162 163 /* 164 * Allows to pass three arguments to the host: port is 16bit wide, 165 * arg0 & arg1 are 64bit wide 166 */ 167 #define GUEST_SYNC_ARGS(_port, _arg0, _arg1) \ 168 __exit_to_l0(_port, (uint64_t) (_arg0), (uint64_t) (_arg1)) 169 170 #define GUEST_ASSERT(_condition) do { \ 171 if (!(_condition)) \ 172 GUEST_SYNC_ARGS(GUEST_PORT_ABORT, \ 173 "Failed guest assert: " \ 174 #_condition, __LINE__); \ 175 } while (0) 176 177 #define GUEST_SYNC(stage) GUEST_SYNC_ARGS(GUEST_PORT_SYNC, "hello", stage) 178 179 #define GUEST_DONE() GUEST_SYNC_ARGS(GUEST_PORT_DONE, 0, 0) 180 181 struct guest_args { 182 uint64_t arg0; 183 uint64_t arg1; 184 uint16_t port; 185 } __attribute__ ((packed)); 186 187 void guest_args_read(struct kvm_vm *vm, uint32_t vcpu_id, 188 struct guest_args *args); 189 190 #endif /* SELFTEST_KVM_UTIL_H */ 191