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