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