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_DEV_PATH "/dev/kvm" 20 #define KVM_MAX_VCPUS 512 21 22 #define NSEC_PER_SEC 1000000000L 23 24 /* 25 * Callers of kvm_util only have an incomplete/opaque description of the 26 * structure kvm_util is using to maintain the state of a VM. 27 */ 28 struct kvm_vm; 29 30 typedef uint64_t vm_paddr_t; /* Virtual Machine (Guest) physical address */ 31 typedef uint64_t vm_vaddr_t; /* Virtual Machine (Guest) virtual address */ 32 33 /* Minimum allocated guest virtual and physical addresses */ 34 #define KVM_UTIL_MIN_VADDR 0x2000 35 #define KVM_GUEST_PAGE_TABLE_MIN_PADDR 0x180000 36 37 #define DEFAULT_GUEST_PHY_PAGES 512 38 #define DEFAULT_GUEST_STACK_VADDR_MIN 0xab6000 39 #define DEFAULT_STACK_PGS 5 40 41 enum vm_guest_mode { 42 VM_MODE_P52V48_4K, 43 VM_MODE_P52V48_64K, 44 VM_MODE_P48V48_4K, 45 VM_MODE_P48V48_64K, 46 VM_MODE_P40V48_4K, 47 VM_MODE_P40V48_64K, 48 VM_MODE_PXXV48_4K, /* For 48bits VA but ANY bits PA */ 49 VM_MODE_P47V64_4K, 50 VM_MODE_P44V64_4K, 51 NUM_VM_MODES, 52 }; 53 54 #if defined(__aarch64__) 55 56 #define VM_MODE_DEFAULT VM_MODE_P40V48_4K 57 #define MIN_PAGE_SHIFT 12U 58 #define ptes_per_page(page_size) ((page_size) / 8) 59 60 #elif defined(__x86_64__) 61 62 #define VM_MODE_DEFAULT VM_MODE_PXXV48_4K 63 #define MIN_PAGE_SHIFT 12U 64 #define ptes_per_page(page_size) ((page_size) / 8) 65 66 #elif defined(__s390x__) 67 68 #define VM_MODE_DEFAULT VM_MODE_P44V64_4K 69 #define MIN_PAGE_SHIFT 12U 70 #define ptes_per_page(page_size) ((page_size) / 16) 71 72 #endif 73 74 #if defined(__x86_64__) 75 unsigned long vm_compute_max_gfn(struct kvm_vm *vm); 76 #else 77 static inline unsigned long vm_compute_max_gfn(struct kvm_vm *vm) 78 { 79 return ((1ULL << vm->pa_bits) >> vm->page_shift) - 1; 80 } 81 #endif 82 83 #define MIN_PAGE_SIZE (1U << MIN_PAGE_SHIFT) 84 #define PTES_PER_MIN_PAGE ptes_per_page(MIN_PAGE_SIZE) 85 86 struct vm_guest_mode_params { 87 unsigned int pa_bits; 88 unsigned int va_bits; 89 unsigned int page_size; 90 unsigned int page_shift; 91 }; 92 extern const struct vm_guest_mode_params vm_guest_mode_params[]; 93 94 int open_path_or_exit(const char *path, int flags); 95 int open_kvm_dev_path_or_exit(void); 96 int kvm_check_cap(long cap); 97 int vm_enable_cap(struct kvm_vm *vm, struct kvm_enable_cap *cap); 98 int vcpu_enable_cap(struct kvm_vm *vm, uint32_t vcpu_id, 99 struct kvm_enable_cap *cap); 100 void vm_enable_dirty_ring(struct kvm_vm *vm, uint32_t ring_size); 101 const char *vm_guest_mode_string(uint32_t i); 102 103 struct kvm_vm *vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm); 104 void kvm_vm_free(struct kvm_vm *vmp); 105 void kvm_vm_restart(struct kvm_vm *vmp, int perm); 106 void kvm_vm_release(struct kvm_vm *vmp); 107 void kvm_vm_get_dirty_log(struct kvm_vm *vm, int slot, void *log); 108 void kvm_vm_clear_dirty_log(struct kvm_vm *vm, int slot, void *log, 109 uint64_t first_page, uint32_t num_pages); 110 uint32_t kvm_vm_reset_dirty_ring(struct kvm_vm *vm); 111 112 int kvm_memcmp_hva_gva(void *hva, struct kvm_vm *vm, const vm_vaddr_t gva, 113 size_t len); 114 115 void kvm_vm_elf_load(struct kvm_vm *vm, const char *filename); 116 117 void vm_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent); 118 119 /* 120 * VM VCPU Dump 121 * 122 * Input Args: 123 * stream - Output FILE stream 124 * vm - Virtual Machine 125 * vcpuid - VCPU ID 126 * indent - Left margin indent amount 127 * 128 * Output Args: None 129 * 130 * Return: None 131 * 132 * Dumps the current state of the VCPU specified by @vcpuid, within the VM 133 * given by @vm, to the FILE stream given by @stream. 134 */ 135 void vcpu_dump(FILE *stream, struct kvm_vm *vm, uint32_t vcpuid, 136 uint8_t indent); 137 138 void vm_create_irqchip(struct kvm_vm *vm); 139 140 void vm_userspace_mem_region_add(struct kvm_vm *vm, 141 enum vm_mem_backing_src_type src_type, 142 uint64_t guest_paddr, uint32_t slot, uint64_t npages, 143 uint32_t flags); 144 145 void vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, 146 void *arg); 147 int _vcpu_ioctl(struct kvm_vm *vm, uint32_t vcpuid, unsigned long ioctl, 148 void *arg); 149 void vm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg); 150 int _vm_ioctl(struct kvm_vm *vm, unsigned long cmd, void *arg); 151 void kvm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg); 152 int _kvm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg); 153 void vm_mem_region_set_flags(struct kvm_vm *vm, uint32_t slot, uint32_t flags); 154 void vm_mem_region_move(struct kvm_vm *vm, uint32_t slot, uint64_t new_gpa); 155 void vm_mem_region_delete(struct kvm_vm *vm, uint32_t slot); 156 void vm_vcpu_add(struct kvm_vm *vm, uint32_t vcpuid); 157 vm_vaddr_t vm_vaddr_alloc(struct kvm_vm *vm, size_t sz, vm_vaddr_t vaddr_min); 158 vm_vaddr_t vm_vaddr_alloc_pages(struct kvm_vm *vm, int nr_pages); 159 vm_vaddr_t vm_vaddr_alloc_page(struct kvm_vm *vm); 160 161 void virt_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr, 162 unsigned int npages); 163 void *addr_gpa2hva(struct kvm_vm *vm, vm_paddr_t gpa); 164 void *addr_gva2hva(struct kvm_vm *vm, vm_vaddr_t gva); 165 vm_paddr_t addr_hva2gpa(struct kvm_vm *vm, void *hva); 166 void *addr_gpa2alias(struct kvm_vm *vm, vm_paddr_t gpa); 167 168 /* 169 * Address Guest Virtual to Guest Physical 170 * 171 * Input Args: 172 * vm - Virtual Machine 173 * gva - VM virtual address 174 * 175 * Output Args: None 176 * 177 * Return: 178 * Equivalent VM physical address 179 * 180 * Returns the VM physical address of the translated VM virtual 181 * address given by @gva. 182 */ 183 vm_paddr_t addr_gva2gpa(struct kvm_vm *vm, vm_vaddr_t gva); 184 185 struct kvm_run *vcpu_state(struct kvm_vm *vm, uint32_t vcpuid); 186 void vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); 187 int _vcpu_run(struct kvm_vm *vm, uint32_t vcpuid); 188 int vcpu_get_fd(struct kvm_vm *vm, uint32_t vcpuid); 189 void vcpu_run_complete_io(struct kvm_vm *vm, uint32_t vcpuid); 190 void vcpu_set_guest_debug(struct kvm_vm *vm, uint32_t vcpuid, 191 struct kvm_guest_debug *debug); 192 void vcpu_set_mp_state(struct kvm_vm *vm, uint32_t vcpuid, 193 struct kvm_mp_state *mp_state); 194 struct kvm_reg_list *vcpu_get_reg_list(struct kvm_vm *vm, uint32_t vcpuid); 195 void vcpu_regs_get(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs); 196 void vcpu_regs_set(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_regs *regs); 197 198 /* 199 * VM VCPU Args Set 200 * 201 * Input Args: 202 * vm - Virtual Machine 203 * vcpuid - VCPU ID 204 * num - number of arguments 205 * ... - arguments, each of type uint64_t 206 * 207 * Output Args: None 208 * 209 * Return: None 210 * 211 * Sets the first @num function input registers of the VCPU with @vcpuid, 212 * per the C calling convention of the architecture, to the values given 213 * as variable args. Each of the variable args is expected to be of type 214 * uint64_t. The maximum @num can be is specific to the architecture. 215 */ 216 void vcpu_args_set(struct kvm_vm *vm, uint32_t vcpuid, unsigned int num, ...); 217 218 void vcpu_sregs_get(struct kvm_vm *vm, uint32_t vcpuid, 219 struct kvm_sregs *sregs); 220 void vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid, 221 struct kvm_sregs *sregs); 222 int _vcpu_sregs_set(struct kvm_vm *vm, uint32_t vcpuid, 223 struct kvm_sregs *sregs); 224 void vcpu_fpu_get(struct kvm_vm *vm, uint32_t vcpuid, 225 struct kvm_fpu *fpu); 226 void vcpu_fpu_set(struct kvm_vm *vm, uint32_t vcpuid, 227 struct kvm_fpu *fpu); 228 void vcpu_get_reg(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_one_reg *reg); 229 void vcpu_set_reg(struct kvm_vm *vm, uint32_t vcpuid, struct kvm_one_reg *reg); 230 #ifdef __KVM_HAVE_VCPU_EVENTS 231 void vcpu_events_get(struct kvm_vm *vm, uint32_t vcpuid, 232 struct kvm_vcpu_events *events); 233 void vcpu_events_set(struct kvm_vm *vm, uint32_t vcpuid, 234 struct kvm_vcpu_events *events); 235 #endif 236 #ifdef __x86_64__ 237 void vcpu_nested_state_get(struct kvm_vm *vm, uint32_t vcpuid, 238 struct kvm_nested_state *state); 239 int vcpu_nested_state_set(struct kvm_vm *vm, uint32_t vcpuid, 240 struct kvm_nested_state *state, bool ignore_error); 241 #endif 242 void *vcpu_map_dirty_ring(struct kvm_vm *vm, uint32_t vcpuid); 243 244 int _kvm_device_check_attr(int dev_fd, uint32_t group, uint64_t attr); 245 int kvm_device_check_attr(int dev_fd, uint32_t group, uint64_t attr); 246 int _kvm_create_device(struct kvm_vm *vm, uint64_t type, bool test, int *fd); 247 int kvm_create_device(struct kvm_vm *vm, uint64_t type, bool test); 248 int _kvm_device_access(int dev_fd, uint32_t group, uint64_t attr, 249 void *val, bool write); 250 int kvm_device_access(int dev_fd, uint32_t group, uint64_t attr, 251 void *val, bool write); 252 253 int _vcpu_has_device_attr(struct kvm_vm *vm, uint32_t vcpuid, uint32_t group, 254 uint64_t attr); 255 int vcpu_has_device_attr(struct kvm_vm *vm, uint32_t vcpuid, uint32_t group, 256 uint64_t attr); 257 int _vcpu_access_device_attr(struct kvm_vm *vm, uint32_t vcpuid, uint32_t group, 258 uint64_t attr, void *val, bool write); 259 int vcpu_access_device_attr(struct kvm_vm *vm, uint32_t vcpuid, uint32_t group, 260 uint64_t attr, void *val, bool write); 261 262 const char *exit_reason_str(unsigned int exit_reason); 263 264 void virt_pgd_alloc(struct kvm_vm *vm); 265 266 /* 267 * VM Virtual Page Map 268 * 269 * Input Args: 270 * vm - Virtual Machine 271 * vaddr - VM Virtual Address 272 * paddr - VM Physical Address 273 * memslot - Memory region slot for new virtual translation tables 274 * 275 * Output Args: None 276 * 277 * Return: None 278 * 279 * Within @vm, creates a virtual translation for the page starting 280 * at @vaddr to the page starting at @paddr. 281 */ 282 void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr); 283 284 vm_paddr_t vm_phy_page_alloc(struct kvm_vm *vm, vm_paddr_t paddr_min, 285 uint32_t memslot); 286 vm_paddr_t vm_phy_pages_alloc(struct kvm_vm *vm, size_t num, 287 vm_paddr_t paddr_min, uint32_t memslot); 288 vm_paddr_t vm_alloc_page_table(struct kvm_vm *vm); 289 290 /* 291 * Create a VM with reasonable defaults 292 * 293 * Input Args: 294 * vcpuid - The id of the single VCPU to add to the VM. 295 * extra_mem_pages - The number of extra pages to add (this will 296 * decide how much extra space we will need to 297 * setup the page tables using memslot 0) 298 * guest_code - The vCPU's entry point 299 * 300 * Output Args: None 301 * 302 * Return: 303 * Pointer to opaque structure that describes the created VM. 304 */ 305 struct kvm_vm *vm_create_default(uint32_t vcpuid, uint64_t extra_mem_pages, 306 void *guest_code); 307 308 /* Same as vm_create_default, but can be used for more than one vcpu */ 309 struct kvm_vm *vm_create_default_with_vcpus(uint32_t nr_vcpus, uint64_t extra_mem_pages, 310 uint32_t num_percpu_pages, void *guest_code, 311 uint32_t vcpuids[]); 312 313 /* Like vm_create_default_with_vcpus, but accepts mode and slot0 memory as a parameter */ 314 struct kvm_vm *vm_create_with_vcpus(enum vm_guest_mode mode, uint32_t nr_vcpus, 315 uint64_t slot0_mem_pages, uint64_t extra_mem_pages, 316 uint32_t num_percpu_pages, void *guest_code, 317 uint32_t vcpuids[]); 318 319 /* 320 * Adds a vCPU with reasonable defaults (e.g. a stack) 321 * 322 * Input Args: 323 * vm - Virtual Machine 324 * vcpuid - The id of the VCPU to add to the VM. 325 * guest_code - The vCPU's entry point 326 */ 327 void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code); 328 329 bool vm_is_unrestricted_guest(struct kvm_vm *vm); 330 331 unsigned int vm_get_page_size(struct kvm_vm *vm); 332 unsigned int vm_get_page_shift(struct kvm_vm *vm); 333 uint64_t vm_get_max_gfn(struct kvm_vm *vm); 334 int vm_get_fd(struct kvm_vm *vm); 335 336 unsigned int vm_calc_num_guest_pages(enum vm_guest_mode mode, size_t size); 337 unsigned int vm_num_host_pages(enum vm_guest_mode mode, unsigned int num_guest_pages); 338 unsigned int vm_num_guest_pages(enum vm_guest_mode mode, unsigned int num_host_pages); 339 static inline unsigned int 340 vm_adjust_num_guest_pages(enum vm_guest_mode mode, unsigned int num_guest_pages) 341 { 342 unsigned int n; 343 n = vm_num_guest_pages(mode, vm_num_host_pages(mode, num_guest_pages)); 344 #ifdef __s390x__ 345 /* s390 requires 1M aligned guest sizes */ 346 n = (n + 255) & ~255; 347 #endif 348 return n; 349 } 350 351 struct kvm_userspace_memory_region * 352 kvm_userspace_memory_region_find(struct kvm_vm *vm, uint64_t start, 353 uint64_t end); 354 355 struct kvm_dirty_log * 356 allocate_kvm_dirty_log(struct kvm_userspace_memory_region *region); 357 358 int vm_create_device(struct kvm_vm *vm, struct kvm_create_device *cd); 359 360 #define sync_global_to_guest(vm, g) ({ \ 361 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ 362 memcpy(_p, &(g), sizeof(g)); \ 363 }) 364 365 #define sync_global_from_guest(vm, g) ({ \ 366 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \ 367 memcpy(&(g), _p, sizeof(g)); \ 368 }) 369 370 void assert_on_unhandled_exception(struct kvm_vm *vm, uint32_t vcpuid); 371 372 /* Common ucalls */ 373 enum { 374 UCALL_NONE, 375 UCALL_SYNC, 376 UCALL_ABORT, 377 UCALL_DONE, 378 UCALL_UNHANDLED, 379 }; 380 381 #define UCALL_MAX_ARGS 6 382 383 struct ucall { 384 uint64_t cmd; 385 uint64_t args[UCALL_MAX_ARGS]; 386 }; 387 388 void ucall_init(struct kvm_vm *vm, void *arg); 389 void ucall_uninit(struct kvm_vm *vm); 390 void ucall(uint64_t cmd, int nargs, ...); 391 uint64_t get_ucall(struct kvm_vm *vm, uint32_t vcpu_id, struct ucall *uc); 392 393 #define GUEST_SYNC_ARGS(stage, arg1, arg2, arg3, arg4) \ 394 ucall(UCALL_SYNC, 6, "hello", stage, arg1, arg2, arg3, arg4) 395 #define GUEST_SYNC(stage) ucall(UCALL_SYNC, 2, "hello", stage) 396 #define GUEST_DONE() ucall(UCALL_DONE, 0) 397 #define __GUEST_ASSERT(_condition, _condstr, _nargs, _args...) do { \ 398 if (!(_condition)) \ 399 ucall(UCALL_ABORT, 2 + _nargs, \ 400 "Failed guest assert: " \ 401 _condstr, __LINE__, _args); \ 402 } while (0) 403 404 #define GUEST_ASSERT(_condition) \ 405 __GUEST_ASSERT(_condition, #_condition, 0, 0) 406 407 #define GUEST_ASSERT_1(_condition, arg1) \ 408 __GUEST_ASSERT(_condition, #_condition, 1, (arg1)) 409 410 #define GUEST_ASSERT_2(_condition, arg1, arg2) \ 411 __GUEST_ASSERT(_condition, #_condition, 2, (arg1), (arg2)) 412 413 #define GUEST_ASSERT_3(_condition, arg1, arg2, arg3) \ 414 __GUEST_ASSERT(_condition, #_condition, 3, (arg1), (arg2), (arg3)) 415 416 #define GUEST_ASSERT_4(_condition, arg1, arg2, arg3, arg4) \ 417 __GUEST_ASSERT(_condition, #_condition, 4, (arg1), (arg2), (arg3), (arg4)) 418 419 #define GUEST_ASSERT_EQ(a, b) __GUEST_ASSERT((a) == (b), #a " == " #b, 2, a, b) 420 421 int vm_get_stats_fd(struct kvm_vm *vm); 422 int vcpu_get_stats_fd(struct kvm_vm *vm, uint32_t vcpuid); 423 424 uint32_t guest_get_vcpuid(void); 425 426 #endif /* SELFTEST_KVM_UTIL_H */ 427