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