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_MAX_VCPUS 512 20 21 /* 22 * Callers of kvm_util only have an incomplete/opaque description of the 23 * structure kvm_util is using to maintain the state of a VM. 24 */ 25 struct kvm_vm; 26 27 typedef uint64_t vm_paddr_t; /* Virtual Machine (Guest) physical address */ 28 typedef uint64_t vm_vaddr_t; /* Virtual Machine (Guest) virtual address */ 29 30 /* Minimum allocated guest virtual and physical addresses */ 31 #define KVM_UTIL_MIN_VADDR 0x2000 32 33 #define DEFAULT_GUEST_PHY_PAGES 512 34 #define DEFAULT_GUEST_STACK_VADDR_MIN 0xab6000 35 #define DEFAULT_STACK_PGS 5 36 37 enum vm_guest_mode { 38 VM_MODE_P52V48_4K, 39 VM_MODE_P52V48_64K, 40 VM_MODE_P48V48_4K, 41 VM_MODE_P48V48_64K, 42 VM_MODE_P40V48_4K, 43 VM_MODE_P40V48_64K, 44 VM_MODE_PXXV48_4K, /* For 48bits VA but ANY bits PA */ 45 NUM_VM_MODES, 46 }; 47 48 #if defined(__aarch64__) 49 50 #define VM_MODE_DEFAULT VM_MODE_P40V48_4K 51 #define MIN_PAGE_SHIFT 12U 52 #define ptes_per_page(page_size) ((page_size) / 8) 53 54 #elif defined(__x86_64__) 55 56 #define VM_MODE_DEFAULT VM_MODE_PXXV48_4K 57 #define MIN_PAGE_SHIFT 12U 58 #define ptes_per_page(page_size) ((page_size) / 8) 59 60 #elif defined(__s390x__) 61 62 #define VM_MODE_DEFAULT VM_MODE_P52V48_4K 63 #define MIN_PAGE_SHIFT 12U 64 #define ptes_per_page(page_size) ((page_size) / 16) 65 66 #endif 67 68 #define MIN_PAGE_SIZE (1U << MIN_PAGE_SHIFT) 69 #define PTES_PER_MIN_PAGE ptes_per_page(MIN_PAGE_SIZE) 70 71 #define vm_guest_mode_string(m) vm_guest_mode_string[m] 72 extern const char * const vm_guest_mode_string[]; 73 74 struct vm_guest_mode_params { 75 unsigned int pa_bits; 76 unsigned int va_bits; 77 unsigned int page_size; 78 unsigned int page_shift; 79 }; 80 extern const struct vm_guest_mode_params vm_guest_mode_params[]; 81 82 int kvm_check_cap(long cap); 83 int vm_enable_cap(struct kvm_vm *vm, struct kvm_enable_cap *cap); 84 int vcpu_enable_cap(struct kvm_vm *vm, uint32_t vcpu_id, 85 struct kvm_enable_cap *cap); 86 void vm_enable_dirty_ring(struct kvm_vm *vm, uint32_t ring_size); 87 88 struct kvm_vm *vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm); 89 void kvm_vm_free(struct kvm_vm *vmp); 90 void kvm_vm_restart(struct kvm_vm *vmp, int perm); 91 void kvm_vm_release(struct kvm_vm *vmp); 92 void kvm_vm_get_dirty_log(struct kvm_vm *vm, int slot, void *log); 93 void kvm_vm_clear_dirty_log(struct kvm_vm *vm, int slot, void *log, 94 uint64_t first_page, uint32_t num_pages); 95 uint32_t kvm_vm_reset_dirty_ring(struct kvm_vm *vm); 96 97 int kvm_memcmp_hva_gva(void *hva, struct kvm_vm *vm, const vm_vaddr_t gva, 98 size_t len); 99 100 void kvm_vm_elf_load(struct kvm_vm *vm, const char *filename, 101 uint32_t data_memslot, uint32_t pgd_memslot); 102 103 void vm_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent); 104 105 /* 106 * VM VCPU Dump 107 * 108 * Input Args: 109 * stream - Output FILE stream 110 * vm - Virtual Machine 111 * vcpuid - VCPU ID 112 * indent - Left margin indent amount 113 * 114 * Output Args: None 115 * 116 * Return: None 117 * 118 * Dumps the current state of the VCPU specified by @vcpuid, within the VM 119 * given by @vm, to the FILE stream given by @stream. 120 */ 121 void vcpu_dump(FILE *stream, struct kvm_vm *vm, uint32_t vcpuid, 122 uint8_t indent); 123 124 void vm_create_irqchip(struct kvm_vm *vm); 125 126 void vm_userspace_mem_region_add(struct kvm_vm *vm, 127 enum vm_mem_backing_src_type src_type, 128 uint64_t guest_paddr, uint32_t slot, uint64_t npages, 129 uint32_t flags); 130 131 void vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, 132 void *arg); 133 int _vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, 134 void *arg); 135 void vm_ioctl(struct kvm_vm *vm, unsigned long ioctl, 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 const char *exit_reason_str(unsigned int exit_reason); 227 228 void virt_pgd_alloc(struct kvm_vm *vm, uint32_t pgd_memslot); 229 230 /* 231 * VM Virtual Page Map 232 * 233 * Input Args: 234 * vm - Virtual Machine 235 * vaddr - VM Virtual Address 236 * paddr - VM Physical Address 237 * memslot - Memory region slot for new virtual translation tables 238 * 239 * Output Args: None 240 * 241 * Return: None 242 * 243 * Within @vm, creates a virtual translation for the page starting 244 * at @vaddr to the page starting at @paddr. 245 */ 246 void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, 247 uint32_t memslot); 248 249 vm_paddr_t vm_phy_page_alloc(struct kvm_vm *vm, vm_paddr_t paddr_min, 250 uint32_t memslot); 251 vm_paddr_t vm_phy_pages_alloc(struct kvm_vm *vm, size_t num, 252 vm_paddr_t paddr_min, uint32_t memslot); 253 254 /* 255 * Create a VM with reasonable defaults 256 * 257 * Input Args: 258 * vcpuid - The id of the single VCPU to add to the VM. 259 * extra_mem_pages - The number of extra pages to add (this will 260 * decide how much extra space we will need to 261 * setup the page tables using memslot 0) 262 * guest_code - The vCPU's entry point 263 * 264 * Output Args: None 265 * 266 * Return: 267 * Pointer to opaque structure that describes the created VM. 268 */ 269 struct kvm_vm *vm_create_default(uint32_t vcpuid, uint64_t extra_mem_pages, 270 void *guest_code); 271 272 /* Same as vm_create_default, but can be used for more than one vcpu */ 273 struct kvm_vm *vm_create_default_with_vcpus(uint32_t nr_vcpus, uint64_t extra_mem_pages, 274 uint32_t num_percpu_pages, void *guest_code, 275 uint32_t vcpuids[]); 276 277 /* Like vm_create_default_with_vcpus, but accepts mode as a parameter */ 278 struct kvm_vm *vm_create_with_vcpus(enum vm_guest_mode mode, uint32_t nr_vcpus, 279 uint64_t extra_mem_pages, uint32_t num_percpu_pages, 280 void *guest_code, uint32_t vcpuids[]); 281 282 /* 283 * Adds a vCPU with reasonable defaults (e.g. a stack) 284 * 285 * Input Args: 286 * vm - Virtual Machine 287 * vcpuid - The id of the VCPU to add to the VM. 288 * guest_code - The vCPU's entry point 289 */ 290 void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code); 291 292 bool vm_is_unrestricted_guest(struct kvm_vm *vm); 293 294 unsigned int vm_get_page_size(struct kvm_vm *vm); 295 unsigned int vm_get_page_shift(struct kvm_vm *vm); 296 unsigned int vm_get_max_gfn(struct kvm_vm *vm); 297 int vm_get_fd(struct kvm_vm *vm); 298 299 unsigned int vm_calc_num_guest_pages(enum vm_guest_mode mode, size_t size); 300 unsigned int vm_num_host_pages(enum vm_guest_mode mode, unsigned int num_guest_pages); 301 unsigned int vm_num_guest_pages(enum vm_guest_mode mode, unsigned int num_host_pages); 302 static inline unsigned int 303 vm_adjust_num_guest_pages(enum vm_guest_mode mode, unsigned int num_guest_pages) 304 { 305 unsigned int n; 306 n = vm_num_guest_pages(mode, vm_num_host_pages(mode, num_guest_pages)); 307 #ifdef __s390x__ 308 /* s390 requires 1M aligned guest sizes */ 309 n = (n + 255) & ~255; 310 #endif 311 return n; 312 } 313 314 struct kvm_userspace_memory_region * 315 kvm_userspace_memory_region_find(struct kvm_vm *vm, uint64_t start, 316 uint64_t end); 317 318 struct kvm_dirty_log * 319 allocate_kvm_dirty_log(struct kvm_userspace_memory_region *region); 320 321 int vm_create_device(struct kvm_vm *vm, struct kvm_create_device *cd); 322 323 #define sync_global_to_guest(vm, g) ({ \ 324 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ 325 memcpy(_p, &(g), sizeof(g)); \ 326 }) 327 328 #define sync_global_from_guest(vm, g) ({ \ 329 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ 330 memcpy(&(g), _p, sizeof(g)); \ 331 }) 332 333 void assert_on_unhandled_exception(struct kvm_vm *vm, uint32_t vcpuid); 334 335 /* Common ucalls */ 336 enum { 337 UCALL_NONE, 338 UCALL_SYNC, 339 UCALL_ABORT, 340 UCALL_DONE, 341 }; 342 343 #define UCALL_MAX_ARGS 6 344 345 struct ucall { 346 uint64_t cmd; 347 uint64_t args[UCALL_MAX_ARGS]; 348 }; 349 350 void ucall_init(struct kvm_vm *vm, void *arg); 351 void ucall_uninit(struct kvm_vm *vm); 352 void ucall(uint64_t cmd, int nargs, ...); 353 uint64_t get_ucall(struct kvm_vm *vm, uint32_t vcpu_id, struct ucall *uc); 354 355 #define GUEST_SYNC_ARGS(stage, arg1, arg2, arg3, arg4) \ 356 ucall(UCALL_SYNC, 6, "hello", stage, arg1, arg2, arg3, arg4) 357 #define GUEST_SYNC(stage) ucall(UCALL_SYNC, 2, "hello", stage) 358 #define GUEST_DONE() ucall(UCALL_DONE, 0) 359 #define __GUEST_ASSERT(_condition, _nargs, _args...) do { \ 360 if (!(_condition)) \ 361 ucall(UCALL_ABORT, 2 + _nargs, \ 362 "Failed guest assert: " \ 363 #_condition, __LINE__, _args); \ 364 } while (0) 365 366 #define GUEST_ASSERT(_condition) \ 367 __GUEST_ASSERT((_condition), 0, 0) 368 369 #define GUEST_ASSERT_1(_condition, arg1) \ 370 __GUEST_ASSERT((_condition), 1, (arg1)) 371 372 #define GUEST_ASSERT_2(_condition, arg1, arg2) \ 373 __GUEST_ASSERT((_condition), 2, (arg1), (arg2)) 374 375 #define GUEST_ASSERT_3(_condition, arg1, arg2, arg3) \ 376 __GUEST_ASSERT((_condition), 3, (arg1), (arg2), (arg3)) 377 378 #define GUEST_ASSERT_4(_condition, arg1, arg2, arg3, arg4) \ 379 __GUEST_ASSERT((_condition), 4, (arg1), (arg2), (arg3), (arg4)) 380 381 #endif /* SELFTEST_KVM_UTIL_H */ 382