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

   1 /*
   2  * tools/testing/selftests/kvm/include/kvm_util.h
   3  *
   4  * Copyright (C) 2018, Google LLC.
   5  *
   6  * This work is licensed under the terms of the GNU GPL, version 2.
   7  *
   8  */
   9 #ifndef SELFTEST_KVM_UTIL_H
  10 #define SELFTEST_KVM_UTIL_H 1
  11
  12 #include "test_util.h"
  13
  14 #include "asm/kvm.h"
  15 #include "linux/kvm.h"
  16 #include <sys/ioctl.h>
  17
  18 #include "sparsebit.h"
  19
  20 /*
  21  * Memslots can't cover the gfn starting at this gpa otherwise vCPUs can't be
  22  * created. Only applies to VMs using EPT.
  23  */
  24 #define KVM_DEFAULT_IDENTITY_MAP_ADDRESS 0xfffbc000ul
  25
  26
  27 /* Callers of kvm_util only have an incomplete/opaque description of the
  28  * structure kvm_util is using to maintain the state of a VM.
  29  */
  30 struct kvm_vm;
  31
  32 typedef uint64_t vm_paddr_t; /* Virtual Machine (Guest) physical address */
  33 typedef uint64_t vm_vaddr_t; /* Virtual Machine (Guest) virtual address */
  34
  35 /* Minimum allocated guest virtual and physical addresses */
  36 #define KVM_UTIL_MIN_VADDR 0x2000
  37
  38 #define DEFAULT_GUEST_PHY_PAGES         512
  39 #define DEFAULT_GUEST_STACK_VADDR_MIN   0xab6000
  40 #define DEFAULT_STACK_PGS               5
  41
  42 enum vm_guest_mode {
  43         VM_MODE_FLAT48PG,
  44 };
  45
  46 enum vm_mem_backing_src_type {
  47         VM_MEM_SRC_ANONYMOUS,
  48         VM_MEM_SRC_ANONYMOUS_THP,
  49         VM_MEM_SRC_ANONYMOUS_HUGETLB,
  50 };
  51
  52 int kvm_check_cap(long cap);
  53
  54 struct kvm_vm *vm_create(enum vm_guest_mode mode, uint64_t phy_pages, int perm);
  55 void kvm_vm_free(struct kvm_vm *vmp);
  56 void kvm_vm_restart(struct kvm_vm *vmp, int perm);
  57 void kvm_vm_release(struct kvm_vm *vmp);
  58
  59 int kvm_memcmp_hva_gva(void *hva,
  60         struct kvm_vm *vm, const vm_vaddr_t gva, size_t len);
  61
  62 void kvm_vm_elf_load(struct kvm_vm *vm, const char *filename,
  63         uint32_t data_memslot, uint32_t pgd_memslot);
  64
  65 void vm_dump(FILE *stream, struct kvm_vm *vm, uint8_t indent);
  66 void vcpu_dump(FILE *stream, struct kvm_vm *vm,
  67         uint32_t vcpuid, uint8_t indent);
  68
  69 void vm_create_irqchip(struct kvm_vm *vm);
  70
  71 void vm_userspace_mem_region_add(struct kvm_vm *vm,
  72         enum vm_mem_backing_src_type src_type,
  73         uint64_t guest_paddr, uint32_t slot, uint64_t npages,
  74         uint32_t flags);
  75
  76 void vcpu_ioctl(struct kvm_vm *vm,
  77         uint32_t vcpuid, unsigned long ioctl, void *arg);
  78 void vm_ioctl(struct kvm_vm *vm, unsigned long ioctl, void *arg);
  79 void vm_mem_region_set_flags(struct kvm_vm *vm, uint32_t slot, uint32_t flags);
  80 void vm_vcpu_add(struct kvm_vm *vm, uint32_t vcpuid, int pgd_memslot, int gdt_memslot);
  81 vm_vaddr_t vm_vaddr_alloc(struct kvm_vm *vm, size_t sz, vm_vaddr_t vaddr_min,
  82         uint32_t data_memslot, uint32_t pgd_memslot);
  83 void *addr_gpa2hva(struct kvm_vm *vm, vm_paddr_t gpa);
  84 void *addr_gva2hva(struct kvm_vm *vm, vm_vaddr_t gva);
  85 vm_paddr_t addr_hva2gpa(struct kvm_vm *vm, void *hva);
  86 vm_paddr_t addr_gva2gpa(struct kvm_vm *vm, vm_vaddr_t gva);
  87
  88 struct kvm_run *vcpu_state(struct kvm_vm *vm, uint32_t vcpuid);
  89 void vcpu_run(struct kvm_vm *vm, uint32_t vcpuid);
  90 int _vcpu_run(struct kvm_vm *vm, uint32_t vcpuid);
  91 void vcpu_set_mp_state(struct kvm_vm *vm, uint32_t vcpuid,
  92         struct kvm_mp_state *mp_state);
  93 void vcpu_regs_get(struct kvm_vm *vm,
  94         uint32_t vcpuid, struct kvm_regs *regs);
  95 void vcpu_regs_set(struct kvm_vm *vm,
  96         uint32_t vcpuid, struct kvm_regs *regs);
  97 void vcpu_args_set(struct kvm_vm *vm, uint32_t vcpuid, unsigned int num, ...);
  98 void vcpu_sregs_get(struct kvm_vm *vm,
  99         uint32_t vcpuid, struct kvm_sregs *sregs);
 100 void vcpu_sregs_set(struct kvm_vm *vm,
 101         uint32_t vcpuid, struct kvm_sregs *sregs);
 102 int _vcpu_sregs_set(struct kvm_vm *vm,
 103         uint32_t vcpuid, struct kvm_sregs *sregs);
 104 void vcpu_events_get(struct kvm_vm *vm, uint32_t vcpuid,
 105                           struct kvm_vcpu_events *events);
 106 void vcpu_events_set(struct kvm_vm *vm, uint32_t vcpuid,
 107                           struct kvm_vcpu_events *events);
 108
 109 const char *exit_reason_str(unsigned int exit_reason);
 110
 111 void virt_pgd_alloc(struct kvm_vm *vm, uint32_t pgd_memslot);
 112 void virt_pg_map(struct kvm_vm *vm, uint64_t vaddr, uint64_t paddr,
 113         uint32_t pgd_memslot);
 114 vm_paddr_t vm_phy_page_alloc(struct kvm_vm *vm,
 115         vm_paddr_t paddr_min, uint32_t memslot);
 116
 117 struct kvm_cpuid2 *kvm_get_supported_cpuid(void);
 118 void vcpu_set_cpuid(
 119         struct kvm_vm *vm, uint32_t vcpuid, struct kvm_cpuid2 *cpuid);
 120
 121 struct kvm_cpuid_entry2 *
 122 kvm_get_supported_cpuid_index(uint32_t function, uint32_t index);
 123
 124 static inline struct kvm_cpuid_entry2 *
 125 kvm_get_supported_cpuid_entry(uint32_t function)
 126 {
 127         return kvm_get_supported_cpuid_index(function, 0);
 128 }
 129
 130 struct kvm_vm *vm_create_default(uint32_t vcpuid, void *guest_code);
 131 void vm_vcpu_add_default(struct kvm_vm *vm, uint32_t vcpuid, void *guest_code);
 132
 133 typedef void (*vmx_guest_code_t)(vm_vaddr_t vmxon_vaddr,
 134                                  vm_paddr_t vmxon_paddr,
 135                                  vm_vaddr_t vmcs_vaddr,
 136                                  vm_paddr_t vmcs_paddr);
 137
 138 struct kvm_userspace_memory_region *
 139 kvm_userspace_memory_region_find(struct kvm_vm *vm, uint64_t start,
 140                                  uint64_t end);
 141
 142 struct kvm_dirty_log *
 143 allocate_kvm_dirty_log(struct kvm_userspace_memory_region *region);
 144
 145 int vm_create_device(struct kvm_vm *vm, struct kvm_create_device *cd);
 146
 147 #endif /* SELFTEST_KVM_UTIL_H */