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