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