xref: /linux-6.15/include/linux/kvm_host.h (revision d289bf7b)
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 rw_semaphore slots_lock;
111 	struct mm_struct *mm; /* userspace tied to this vm */
112 	int nmemslots;
113 	struct kvm_memory_slot memslots[KVM_MEMORY_SLOTS +
114 					KVM_PRIVATE_MEM_SLOTS];
115 	struct kvm_vcpu *vcpus[KVM_MAX_VCPUS];
116 	struct list_head vm_list;
117 	struct file *filp;
118 	struct kvm_io_bus mmio_bus;
119 	struct kvm_io_bus pio_bus;
120 	struct kvm_vm_stat stat;
121 	struct kvm_arch arch;
122 };
123 
124 /* The guest did something we don't support. */
125 #define pr_unimpl(vcpu, fmt, ...)					\
126  do {									\
127 	if (printk_ratelimit())						\
128 		printk(KERN_ERR "kvm: %i: cpu%i " fmt,			\
129 		       current->tgid, (vcpu)->vcpu_id , ## __VA_ARGS__); \
130  } while (0)
131 
132 #define kvm_printf(kvm, fmt ...) printk(KERN_DEBUG fmt)
133 #define vcpu_printf(vcpu, fmt...) kvm_printf(vcpu->kvm, fmt)
134 
135 int kvm_vcpu_init(struct kvm_vcpu *vcpu, struct kvm *kvm, unsigned id);
136 void kvm_vcpu_uninit(struct kvm_vcpu *vcpu);
137 
138 void vcpu_load(struct kvm_vcpu *vcpu);
139 void vcpu_put(struct kvm_vcpu *vcpu);
140 
141 void decache_vcpus_on_cpu(int cpu);
142 
143 
144 int kvm_init(void *opaque, unsigned int vcpu_size,
145 		  struct module *module);
146 void kvm_exit(void);
147 
148 #define HPA_MSB ((sizeof(hpa_t) * 8) - 1)
149 #define HPA_ERR_MASK ((hpa_t)1 << HPA_MSB)
150 static inline int is_error_hpa(hpa_t hpa) { return hpa >> HPA_MSB; }
151 struct page *gva_to_page(struct kvm_vcpu *vcpu, gva_t gva);
152 
153 extern struct page *bad_page;
154 
155 int is_error_page(struct page *page);
156 int kvm_is_error_hva(unsigned long addr);
157 int kvm_set_memory_region(struct kvm *kvm,
158 			  struct kvm_userspace_memory_region *mem,
159 			  int user_alloc);
160 int __kvm_set_memory_region(struct kvm *kvm,
161 			    struct kvm_userspace_memory_region *mem,
162 			    int user_alloc);
163 int kvm_arch_set_memory_region(struct kvm *kvm,
164 				struct kvm_userspace_memory_region *mem,
165 				struct kvm_memory_slot old,
166 				int user_alloc);
167 gfn_t unalias_gfn(struct kvm *kvm, gfn_t gfn);
168 struct page *gfn_to_page(struct kvm *kvm, gfn_t gfn);
169 void kvm_release_page_clean(struct page *page);
170 void kvm_release_page_dirty(struct page *page);
171 int kvm_read_guest_page(struct kvm *kvm, gfn_t gfn, void *data, int offset,
172 			int len);
173 int kvm_read_guest_atomic(struct kvm *kvm, gpa_t gpa, void *data,
174 			  unsigned long len);
175 int kvm_read_guest(struct kvm *kvm, gpa_t gpa, void *data, unsigned long len);
176 int kvm_write_guest_page(struct kvm *kvm, gfn_t gfn, const void *data,
177 			 int offset, int len);
178 int kvm_write_guest(struct kvm *kvm, gpa_t gpa, const void *data,
179 		    unsigned long len);
180 int kvm_clear_guest_page(struct kvm *kvm, gfn_t gfn, int offset, int len);
181 int kvm_clear_guest(struct kvm *kvm, gpa_t gpa, unsigned long len);
182 struct kvm_memory_slot *gfn_to_memslot(struct kvm *kvm, gfn_t gfn);
183 int kvm_is_visible_gfn(struct kvm *kvm, gfn_t gfn);
184 void mark_page_dirty(struct kvm *kvm, gfn_t gfn);
185 
186 void kvm_vcpu_block(struct kvm_vcpu *vcpu);
187 void kvm_resched(struct kvm_vcpu *vcpu);
188 void kvm_load_guest_fpu(struct kvm_vcpu *vcpu);
189 void kvm_put_guest_fpu(struct kvm_vcpu *vcpu);
190 void kvm_flush_remote_tlbs(struct kvm *kvm);
191 
192 long kvm_arch_dev_ioctl(struct file *filp,
193 			unsigned int ioctl, unsigned long arg);
194 long kvm_arch_vcpu_ioctl(struct file *filp,
195 			 unsigned int ioctl, unsigned long arg);
196 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
197 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
198 
199 int kvm_dev_ioctl_check_extension(long ext);
200 
201 int kvm_get_dirty_log(struct kvm *kvm,
202 			struct kvm_dirty_log *log, int *is_dirty);
203 int kvm_vm_ioctl_get_dirty_log(struct kvm *kvm,
204 				struct kvm_dirty_log *log);
205 
206 int kvm_vm_ioctl_set_memory_region(struct kvm *kvm,
207 				   struct
208 				   kvm_userspace_memory_region *mem,
209 				   int user_alloc);
210 long kvm_arch_vm_ioctl(struct file *filp,
211 		       unsigned int ioctl, unsigned long arg);
212 void kvm_arch_destroy_vm(struct kvm *kvm);
213 
214 int kvm_arch_vcpu_ioctl_get_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
215 int kvm_arch_vcpu_ioctl_set_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
216 
217 int kvm_arch_vcpu_ioctl_translate(struct kvm_vcpu *vcpu,
218 				    struct kvm_translation *tr);
219 
220 int kvm_arch_vcpu_ioctl_get_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
221 int kvm_arch_vcpu_ioctl_set_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
222 int kvm_arch_vcpu_ioctl_get_sregs(struct kvm_vcpu *vcpu,
223 				  struct kvm_sregs *sregs);
224 int kvm_arch_vcpu_ioctl_set_sregs(struct kvm_vcpu *vcpu,
225 				  struct kvm_sregs *sregs);
226 int kvm_arch_vcpu_ioctl_debug_guest(struct kvm_vcpu *vcpu,
227 				    struct kvm_debug_guest *dbg);
228 int kvm_arch_vcpu_ioctl_run(struct kvm_vcpu *vcpu, struct kvm_run *kvm_run);
229 
230 int kvm_arch_init(void *opaque);
231 void kvm_arch_exit(void);
232 
233 int kvm_arch_vcpu_init(struct kvm_vcpu *vcpu);
234 void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu);
235 
236 void kvm_arch_vcpu_free(struct kvm_vcpu *vcpu);
237 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
238 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
239 struct kvm_vcpu *kvm_arch_vcpu_create(struct kvm *kvm, unsigned int id);
240 int kvm_arch_vcpu_setup(struct kvm_vcpu *vcpu);
241 void kvm_arch_vcpu_destroy(struct kvm_vcpu *vcpu);
242 
243 int kvm_arch_vcpu_reset(struct kvm_vcpu *vcpu);
244 void kvm_arch_hardware_enable(void *garbage);
245 void kvm_arch_hardware_disable(void *garbage);
246 int kvm_arch_hardware_setup(void);
247 void kvm_arch_hardware_unsetup(void);
248 void kvm_arch_check_processor_compat(void *rtn);
249 int kvm_arch_vcpu_runnable(struct kvm_vcpu *vcpu);
250 
251 void kvm_free_physmem(struct kvm *kvm);
252 
253 struct  kvm *kvm_arch_create_vm(void);
254 void kvm_arch_destroy_vm(struct kvm *kvm);
255 
256 int kvm_cpu_get_interrupt(struct kvm_vcpu *v);
257 int kvm_cpu_has_interrupt(struct kvm_vcpu *v);
258 void kvm_vcpu_kick(struct kvm_vcpu *vcpu);
259 
260 static inline void kvm_guest_enter(void)
261 {
262 	account_system_vtime(current);
263 	current->flags |= PF_VCPU;
264 }
265 
266 static inline void kvm_guest_exit(void)
267 {
268 	account_system_vtime(current);
269 	current->flags &= ~PF_VCPU;
270 }
271 
272 static inline int memslot_id(struct kvm *kvm, struct kvm_memory_slot *slot)
273 {
274 	return slot - kvm->memslots;
275 }
276 
277 static inline gpa_t gfn_to_gpa(gfn_t gfn)
278 {
279 	return (gpa_t)gfn << PAGE_SHIFT;
280 }
281 
282 static inline void kvm_migrate_apic_timer(struct kvm_vcpu *vcpu)
283 {
284 	set_bit(KVM_REQ_MIGRATE_TIMER, &vcpu->requests);
285 }
286 
287 enum kvm_stat_kind {
288 	KVM_STAT_VM,
289 	KVM_STAT_VCPU,
290 };
291 
292 struct kvm_stats_debugfs_item {
293 	const char *name;
294 	int offset;
295 	enum kvm_stat_kind kind;
296 	struct dentry *dentry;
297 };
298 extern struct kvm_stats_debugfs_item debugfs_entries[];
299 
300 #endif
301