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