xref: /linux-6.15/include/linux/kvm_host.h (revision c0a9290e)
1 #ifndef __KVM_HOST_H
2 #define __KVM_HOST_H
3 
4 /*
5  * This work is licensed under the terms of the GNU GPL, version 2.  See
6  * the COPYING file in the top-level directory.
7  */
8 
9 #include <linux/types.h>
10 #include <linux/hardirq.h>
11 #include <linux/list.h>
12 #include <linux/mutex.h>
13 #include <linux/spinlock.h>
14 #include <linux/signal.h>
15 #include <linux/sched.h>
16 #include <linux/mm.h>
17 #include <linux/preempt.h>
18 #include <asm/signal.h>
19 
20 #include <linux/kvm.h>
21 #include <linux/kvm_para.h>
22 
23 #include <linux/kvm_types.h>
24 
25 #include <asm/kvm_host.h>
26 
27 #define KVM_MAX_VCPUS 4
28 #define KVM_MEMORY_SLOTS 8
29 /* memory slots that does not exposed to userspace */
30 #define KVM_PRIVATE_MEM_SLOTS 4
31 
32 #define KVM_PIO_PAGE_OFFSET 1
33 
34 /*
35  * vcpu->requests bit members
36  */
37 #define KVM_REQ_TLB_FLUSH          0
38 #define KVM_REQ_MIGRATE_TIMER      1
39 #define KVM_REQ_REPORT_TPR_ACCESS  2
40 
41 struct kvm_vcpu;
42 extern struct kmem_cache *kvm_vcpu_cache;
43 
44 struct kvm_guest_debug {
45 	int enabled;
46 	unsigned long bp[4];
47 	int singlestep;
48 };
49 
50 /*
51  * It would be nice to use something smarter than a linear search, TBD...
52  * Thankfully we dont expect many devices to register (famous last words :),
53  * so until then it will suffice.  At least its abstracted so we can change
54  * in one place.
55  */
56 struct kvm_io_bus {
57 	int                   dev_count;
58 #define NR_IOBUS_DEVS 6
59 	struct kvm_io_device *devs[NR_IOBUS_DEVS];
60 };
61 
62 void kvm_io_bus_init(struct kvm_io_bus *bus);
63 void kvm_io_bus_destroy(struct kvm_io_bus *bus);
64 struct kvm_io_device *kvm_io_bus_find_dev(struct kvm_io_bus *bus, gpa_t addr);
65 void kvm_io_bus_register_dev(struct kvm_io_bus *bus,
66 			     struct kvm_io_device *dev);
67 
68 struct kvm_vcpu {
69 	struct kvm *kvm;
70 	struct preempt_notifier preempt_notifier;
71 	int vcpu_id;
72 	struct mutex mutex;
73 	int   cpu;
74 	struct kvm_run *run;
75 	int guest_mode;
76 	unsigned long requests;
77 	struct kvm_guest_debug guest_debug;
78 	int fpu_active;
79 	int guest_fpu_loaded;
80 	wait_queue_head_t wq;
81 	int sigset_active;
82 	sigset_t sigset;
83 	struct kvm_vcpu_stat stat;
84 
85 #ifdef CONFIG_HAS_IOMEM
86 	int mmio_needed;
87 	int mmio_read_completed;
88 	int mmio_is_write;
89 	int mmio_size;
90 	unsigned char mmio_data[8];
91 	gpa_t mmio_phys_addr;
92 #endif
93 
94 	struct kvm_vcpu_arch arch;
95 };
96 
97 struct kvm_memory_slot {
98 	gfn_t base_gfn;
99 	unsigned long npages;
100 	unsigned long flags;
101 	unsigned long *rmap;
102 	unsigned long *dirty_bitmap;
103 	unsigned long userspace_addr;
104 	int user_alloc;
105 };
106 
107 struct kvm {
108 	struct mutex lock; /* protects the vcpus array and APIC accesses */
109 	spinlock_t mmu_lock;
110 	struct mm_struct *mm; /* userspace tied to this vm */
111 	int nmemslots;
112 	struct kvm_memory_slot memslots[KVM_MEMORY_SLOTS +
113 					KVM_PRIVATE_MEM_SLOTS];
114 	struct kvm_vcpu *vcpus[KVM_MAX_VCPUS];
115 	struct list_head vm_list;
116 	struct file *filp;
117 	struct kvm_io_bus mmio_bus;
118 	struct kvm_io_bus pio_bus;
119 	struct kvm_vm_stat stat;
120 	struct kvm_arch arch;
121 };
122 
123 /* The guest did something we don't support. */
124 #define pr_unimpl(vcpu, fmt, ...)					\
125  do {									\
126 	if (printk_ratelimit())						\
127 		printk(KERN_ERR "kvm: %i: cpu%i " fmt,			\
128 		       current->tgid, (vcpu)->vcpu_id , ## __VA_ARGS__); \
129  } while (0)
130 
131 #define kvm_printf(kvm, fmt ...) printk(KERN_DEBUG fmt)
132 #define vcpu_printf(vcpu, fmt...) kvm_printf(vcpu->kvm, fmt)
133 
134 int kvm_vcpu_init(struct kvm_vcpu *vcpu, struct kvm *kvm, unsigned id);
135 void kvm_vcpu_uninit(struct kvm_vcpu *vcpu);
136 
137 void vcpu_load(struct kvm_vcpu *vcpu);
138 void vcpu_put(struct kvm_vcpu *vcpu);
139 
140 void decache_vcpus_on_cpu(int cpu);
141 
142 
143 int kvm_init(void *opaque, unsigned int vcpu_size,
144 		  struct module *module);
145 void kvm_exit(void);
146 
147 #define HPA_MSB ((sizeof(hpa_t) * 8) - 1)
148 #define HPA_ERR_MASK ((hpa_t)1 << HPA_MSB)
149 static inline int is_error_hpa(hpa_t hpa) { return hpa >> HPA_MSB; }
150 struct page *gva_to_page(struct kvm_vcpu *vcpu, gva_t gva);
151 
152 extern struct page *bad_page;
153 
154 int is_error_page(struct page *page);
155 int kvm_is_error_hva(unsigned long addr);
156 int kvm_set_memory_region(struct kvm *kvm,
157 			  struct kvm_userspace_memory_region *mem,
158 			  int user_alloc);
159 int __kvm_set_memory_region(struct kvm *kvm,
160 			    struct kvm_userspace_memory_region *mem,
161 			    int user_alloc);
162 int kvm_arch_set_memory_region(struct kvm *kvm,
163 				struct kvm_userspace_memory_region *mem,
164 				struct kvm_memory_slot old,
165 				int user_alloc);
166 gfn_t unalias_gfn(struct kvm *kvm, gfn_t gfn);
167 struct page *gfn_to_page(struct kvm *kvm, gfn_t gfn);
168 void kvm_release_page_clean(struct page *page);
169 void kvm_release_page_dirty(struct page *page);
170 int kvm_read_guest_page(struct kvm *kvm, gfn_t gfn, void *data, int offset,
171 			int len);
172 int kvm_read_guest_atomic(struct kvm *kvm, gpa_t gpa, void *data,
173 			  unsigned long len);
174 int kvm_read_guest(struct kvm *kvm, gpa_t gpa, void *data, unsigned long len);
175 int kvm_write_guest_page(struct kvm *kvm, gfn_t gfn, const void *data,
176 			 int offset, int len);
177 int kvm_write_guest(struct kvm *kvm, gpa_t gpa, const void *data,
178 		    unsigned long len);
179 int kvm_clear_guest_page(struct kvm *kvm, gfn_t gfn, int offset, int len);
180 int kvm_clear_guest(struct kvm *kvm, gpa_t gpa, unsigned long len);
181 struct kvm_memory_slot *gfn_to_memslot(struct kvm *kvm, gfn_t gfn);
182 int kvm_is_visible_gfn(struct kvm *kvm, gfn_t gfn);
183 void mark_page_dirty(struct kvm *kvm, gfn_t gfn);
184 
185 void kvm_vcpu_block(struct kvm_vcpu *vcpu);
186 void kvm_resched(struct kvm_vcpu *vcpu);
187 void kvm_load_guest_fpu(struct kvm_vcpu *vcpu);
188 void kvm_put_guest_fpu(struct kvm_vcpu *vcpu);
189 void kvm_flush_remote_tlbs(struct kvm *kvm);
190 
191 long kvm_arch_dev_ioctl(struct file *filp,
192 			unsigned int ioctl, unsigned long arg);
193 long kvm_arch_vcpu_ioctl(struct file *filp,
194 			 unsigned int ioctl, unsigned long arg);
195 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
196 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
197 
198 int kvm_dev_ioctl_check_extension(long ext);
199 
200 int kvm_get_dirty_log(struct kvm *kvm,
201 			struct kvm_dirty_log *log, int *is_dirty);
202 int kvm_vm_ioctl_get_dirty_log(struct kvm *kvm,
203 				struct kvm_dirty_log *log);
204 
205 int kvm_vm_ioctl_set_memory_region(struct kvm *kvm,
206 				   struct
207 				   kvm_userspace_memory_region *mem,
208 				   int user_alloc);
209 long kvm_arch_vm_ioctl(struct file *filp,
210 		       unsigned int ioctl, unsigned long arg);
211 void kvm_arch_destroy_vm(struct kvm *kvm);
212 
213 int kvm_arch_vcpu_ioctl_get_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
214 int kvm_arch_vcpu_ioctl_set_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
215 
216 int kvm_arch_vcpu_ioctl_translate(struct kvm_vcpu *vcpu,
217 				    struct kvm_translation *tr);
218 
219 int kvm_arch_vcpu_ioctl_get_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
220 int kvm_arch_vcpu_ioctl_set_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
221 int kvm_arch_vcpu_ioctl_get_sregs(struct kvm_vcpu *vcpu,
222 				  struct kvm_sregs *sregs);
223 int kvm_arch_vcpu_ioctl_set_sregs(struct kvm_vcpu *vcpu,
224 				  struct kvm_sregs *sregs);
225 int kvm_arch_vcpu_ioctl_debug_guest(struct kvm_vcpu *vcpu,
226 				    struct kvm_debug_guest *dbg);
227 int kvm_arch_vcpu_ioctl_run(struct kvm_vcpu *vcpu, struct kvm_run *kvm_run);
228 
229 int kvm_arch_init(void *opaque);
230 void kvm_arch_exit(void);
231 
232 int kvm_arch_vcpu_init(struct kvm_vcpu *vcpu);
233 void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu);
234 
235 void kvm_arch_vcpu_free(struct kvm_vcpu *vcpu);
236 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
237 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
238 struct kvm_vcpu *kvm_arch_vcpu_create(struct kvm *kvm, unsigned int id);
239 int kvm_arch_vcpu_setup(struct kvm_vcpu *vcpu);
240 void kvm_arch_vcpu_destroy(struct kvm_vcpu *vcpu);
241 
242 int kvm_arch_vcpu_reset(struct kvm_vcpu *vcpu);
243 void kvm_arch_hardware_enable(void *garbage);
244 void kvm_arch_hardware_disable(void *garbage);
245 int kvm_arch_hardware_setup(void);
246 void kvm_arch_hardware_unsetup(void);
247 void kvm_arch_check_processor_compat(void *rtn);
248 int kvm_arch_vcpu_runnable(struct kvm_vcpu *vcpu);
249 
250 void kvm_free_physmem(struct kvm *kvm);
251 
252 struct  kvm *kvm_arch_create_vm(void);
253 void kvm_arch_destroy_vm(struct kvm *kvm);
254 
255 int kvm_cpu_get_interrupt(struct kvm_vcpu *v);
256 int kvm_cpu_has_interrupt(struct kvm_vcpu *v);
257 void kvm_vcpu_kick(struct kvm_vcpu *vcpu);
258 
259 static inline void kvm_guest_enter(void)
260 {
261 	account_system_vtime(current);
262 	current->flags |= PF_VCPU;
263 }
264 
265 static inline void kvm_guest_exit(void)
266 {
267 	account_system_vtime(current);
268 	current->flags &= ~PF_VCPU;
269 }
270 
271 static inline int memslot_id(struct kvm *kvm, struct kvm_memory_slot *slot)
272 {
273 	return slot - kvm->memslots;
274 }
275 
276 static inline gpa_t gfn_to_gpa(gfn_t gfn)
277 {
278 	return (gpa_t)gfn << PAGE_SHIFT;
279 }
280 
281 static inline void kvm_migrate_apic_timer(struct kvm_vcpu *vcpu)
282 {
283 	set_bit(KVM_REQ_MIGRATE_TIMER, &vcpu->requests);
284 }
285 
286 enum kvm_stat_kind {
287 	KVM_STAT_VM,
288 	KVM_STAT_VCPU,
289 };
290 
291 struct kvm_stats_debugfs_item {
292 	const char *name;
293 	int offset;
294 	enum kvm_stat_kind kind;
295 	struct dentry *dentry;
296 };
297 extern struct kvm_stats_debugfs_item debugfs_entries[];
298 
299 #endif
300