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