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

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