tools/testing/selftests/kvm/include/kvm_util_base.h

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