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