2 * tools/testing/selftests/kvm/include/kvm_util.h
4 * Copyright (C) 2018, Google LLC.
6 * This work is licensed under the terms of the GNU GPL, version 2.
9 #ifndef SELFTEST_KVM_UTIL_H
10 #define SELFTEST_KVM_UTIL_H
12 #include "test_util.h"
15 #include "linux/kvm.h"
16 #include <sys/ioctl.h>
18 #include "sparsebit.h"
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.
26 typedef uint64_t vm_paddr_t
; /* Virtual Machine (Guest) physical address */
27 typedef uint64_t vm_vaddr_t
; /* Virtual Machine (Guest) virtual address */
29 /* Minimum allocated guest virtual and physical addresses */
30 #define KVM_UTIL_MIN_VADDR 0x2000
32 #define DEFAULT_GUEST_PHY_PAGES 512
33 #define DEFAULT_GUEST_STACK_VADDR_MIN 0xab6000
34 #define DEFAULT_STACK_PGS 5
44 #define vm_guest_mode_string(m) vm_guest_mode_string[m]
45 extern const char * const vm_guest_mode_string
[];
47 enum vm_mem_backing_src_type
{
49 VM_MEM_SRC_ANONYMOUS_THP
,
50 VM_MEM_SRC_ANONYMOUS_HUGETLB
,
53 int kvm_check_cap(long cap
);
54 int vm_enable_cap(struct kvm_vm
*vm
, struct kvm_enable_cap
*cap
);
56 struct kvm_vm
*vm_create(enum vm_guest_mode mode
, uint64_t phy_pages
, int perm
);
57 void kvm_vm_free(struct kvm_vm
*vmp
);
58 void kvm_vm_restart(struct kvm_vm
*vmp
, int perm
);
59 void kvm_vm_release(struct kvm_vm
*vmp
);
60 void kvm_vm_get_dirty_log(struct kvm_vm
*vm
, int slot
, void *log
);
61 void kvm_vm_clear_dirty_log(struct kvm_vm
*vm
, int slot
, void *log
,
62 uint64_t first_page
, uint32_t num_pages
);
64 int kvm_memcmp_hva_gva(void *hva
, struct kvm_vm
*vm
, const vm_vaddr_t gva
,
67 void kvm_vm_elf_load(struct kvm_vm
*vm
, const char *filename
,
68 uint32_t data_memslot
, uint32_t pgd_memslot
);
70 void vm_dump(FILE *stream
, struct kvm_vm
*vm
, uint8_t indent
);
71 void vcpu_dump(FILE *stream
, struct kvm_vm
*vm
, uint32_t vcpuid
,
74 void vm_create_irqchip(struct kvm_vm
*vm
);
76 void vm_userspace_mem_region_add(struct kvm_vm
*vm
,
77 enum vm_mem_backing_src_type src_type
,
78 uint64_t guest_paddr
, uint32_t slot
, uint64_t npages
,
81 void vcpu_ioctl(struct kvm_vm
*vm
, uint32_t vcpuid
, unsigned long ioctl
,
83 void vm_ioctl(struct kvm_vm
*vm
, unsigned long ioctl
, void *arg
);
84 void vm_mem_region_set_flags(struct kvm_vm
*vm
, uint32_t slot
, uint32_t flags
);
85 void vm_vcpu_add(struct kvm_vm
*vm
, uint32_t vcpuid
, int pgd_memslot
,
87 vm_vaddr_t
vm_vaddr_alloc(struct kvm_vm
*vm
, size_t sz
, vm_vaddr_t vaddr_min
,
88 uint32_t data_memslot
, uint32_t pgd_memslot
);
89 void virt_map(struct kvm_vm
*vm
, uint64_t vaddr
, uint64_t paddr
,
90 size_t size
, uint32_t pgd_memslot
);
91 void *addr_gpa2hva(struct kvm_vm
*vm
, vm_paddr_t gpa
);
92 void *addr_gva2hva(struct kvm_vm
*vm
, vm_vaddr_t gva
);
93 vm_paddr_t
addr_hva2gpa(struct kvm_vm
*vm
, void *hva
);
94 vm_paddr_t
addr_gva2gpa(struct kvm_vm
*vm
, vm_vaddr_t gva
);
96 struct kvm_run
*vcpu_state(struct kvm_vm
*vm
, uint32_t vcpuid
);
97 void vcpu_run(struct kvm_vm
*vm
, uint32_t vcpuid
);
98 int _vcpu_run(struct kvm_vm
*vm
, uint32_t vcpuid
);
99 void vcpu_set_mp_state(struct kvm_vm
*vm
, uint32_t vcpuid
,
100 struct kvm_mp_state
*mp_state
);
101 void vcpu_regs_get(struct kvm_vm
*vm
, uint32_t vcpuid
, struct kvm_regs
*regs
);
102 void vcpu_regs_set(struct kvm_vm
*vm
, uint32_t vcpuid
, struct kvm_regs
*regs
);
103 void vcpu_args_set(struct kvm_vm
*vm
, uint32_t vcpuid
, unsigned int num
, ...);
104 void vcpu_sregs_get(struct kvm_vm
*vm
, uint32_t vcpuid
,
105 struct kvm_sregs
*sregs
);
106 void vcpu_sregs_set(struct kvm_vm
*vm
, uint32_t vcpuid
,
107 struct kvm_sregs
*sregs
);
108 int _vcpu_sregs_set(struct kvm_vm
*vm
, uint32_t vcpuid
,
109 struct kvm_sregs
*sregs
);
110 void vcpu_events_get(struct kvm_vm
*vm
, uint32_t vcpuid
,
111 struct kvm_vcpu_events
*events
);
112 void vcpu_events_set(struct kvm_vm
*vm
, uint32_t vcpuid
,
113 struct kvm_vcpu_events
*events
);
115 const char *exit_reason_str(unsigned int exit_reason
);
117 void virt_pgd_alloc(struct kvm_vm
*vm
, uint32_t pgd_memslot
);
118 void virt_pg_map(struct kvm_vm
*vm
, uint64_t vaddr
, uint64_t paddr
,
119 uint32_t pgd_memslot
);
120 vm_paddr_t
vm_phy_page_alloc(struct kvm_vm
*vm
, vm_paddr_t paddr_min
,
122 vm_paddr_t
vm_phy_pages_alloc(struct kvm_vm
*vm
, size_t num
,
123 vm_paddr_t paddr_min
, uint32_t memslot
);
125 struct kvm_vm
*vm_create_default(uint32_t vcpuid
, uint64_t extra_mem_size
,
127 void vm_vcpu_add_default(struct kvm_vm
*vm
, uint32_t vcpuid
, void *guest_code
);
129 struct kvm_userspace_memory_region
*
130 kvm_userspace_memory_region_find(struct kvm_vm
*vm
, uint64_t start
,
133 struct kvm_dirty_log
*
134 allocate_kvm_dirty_log(struct kvm_userspace_memory_region
*region
);
136 int vm_create_device(struct kvm_vm
*vm
, struct kvm_create_device
*cd
);
138 #define sync_global_to_guest(vm, g) ({ \
139 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \
140 memcpy(_p, &(g), sizeof(g)); \
143 #define sync_global_from_guest(vm, g) ({ \
144 typeof(g) *_p = addr_gva2hva(vm, (vm_vaddr_t)&(g)); \
145 memcpy(&(g), _p, sizeof(g)); \
148 /* ucall implementation types */
162 #define UCALL_MAX_ARGS 6
166 uint64_t args
[UCALL_MAX_ARGS
];
169 void ucall_init(struct kvm_vm
*vm
, ucall_type_t type
, void *arg
);
170 void ucall_uninit(struct kvm_vm
*vm
);
171 void ucall(uint64_t cmd
, int nargs
, ...);
172 uint64_t get_ucall(struct kvm_vm
*vm
, uint32_t vcpu_id
, struct ucall
*uc
);
174 #define GUEST_SYNC(stage) ucall(UCALL_SYNC, 2, "hello", stage)
175 #define GUEST_DONE() ucall(UCALL_DONE, 0)
176 #define GUEST_ASSERT(_condition) do { \
178 ucall(UCALL_ABORT, 2, \
179 "Failed guest assert: " \
180 #_condition, __LINE__); \
183 #endif /* SELFTEST_KVM_UTIL_H */