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