f403e66557fb07148dc950fb58271bd807be3ee2
[linux-2.6.git] / include / linux / kvm_host.h
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/msi.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 #define KVM_REQ_UNHALT             6
38 #define KVM_REQ_MMU_SYNC           7
39 #define KVM_REQ_KVMCLOCK_UPDATE    8
40 #define KVM_REQ_KICK               9
41
42 #define KVM_USERSPACE_IRQ_SOURCE_ID     0
43
44 struct kvm;
45 struct kvm_vcpu;
46 extern struct kmem_cache *kvm_vcpu_cache;
47
48 /*
49  * It would be nice to use something smarter than a linear search, TBD...
50  * Thankfully we dont expect many devices to register (famous last words :),
51  * so until then it will suffice.  At least its abstracted so we can change
52  * in one place.
53  */
54 struct kvm_io_bus {
55         int                   dev_count;
56 #define NR_IOBUS_DEVS 6
57         struct kvm_io_device *devs[NR_IOBUS_DEVS];
58 };
59
60 void kvm_io_bus_init(struct kvm_io_bus *bus);
61 void kvm_io_bus_destroy(struct kvm_io_bus *bus);
62 int kvm_io_bus_write(struct kvm_io_bus *bus, gpa_t addr, int len,
63                      const void *val);
64 int kvm_io_bus_read(struct kvm_io_bus *bus, gpa_t addr, int len,
65                     void *val);
66 int __kvm_io_bus_register_dev(struct kvm_io_bus *bus,
67                                struct kvm_io_device *dev);
68 int kvm_io_bus_register_dev(struct kvm *kvm, struct kvm_io_bus *bus,
69                             struct kvm_io_device *dev);
70 void __kvm_io_bus_unregister_dev(struct kvm_io_bus *bus,
71                                  struct kvm_io_device *dev);
72 void kvm_io_bus_unregister_dev(struct kvm *kvm, struct kvm_io_bus *bus,
73                                struct kvm_io_device *dev);
74
75 struct kvm_vcpu {
76         struct kvm *kvm;
77 #ifdef CONFIG_PREEMPT_NOTIFIERS
78         struct preempt_notifier preempt_notifier;
79 #endif
80         int vcpu_id;
81         struct mutex mutex;
82         int   cpu;
83         struct kvm_run *run;
84         unsigned long requests;
85         unsigned long guest_debug;
86         int fpu_active;
87         int guest_fpu_loaded;
88         wait_queue_head_t wq;
89         int sigset_active;
90         sigset_t sigset;
91         struct kvm_vcpu_stat stat;
92
93 #ifdef CONFIG_HAS_IOMEM
94         int mmio_needed;
95         int mmio_read_completed;
96         int mmio_is_write;
97         int mmio_size;
98         unsigned char mmio_data[8];
99         gpa_t mmio_phys_addr;
100 #endif
101
102         struct kvm_vcpu_arch arch;
103 };
104
105 struct kvm_memory_slot {
106         gfn_t base_gfn;
107         unsigned long npages;
108         unsigned long flags;
109         unsigned long *rmap;
110         unsigned long *dirty_bitmap;
111         struct {
112                 unsigned long rmap_pde;
113                 int write_count;
114         } *lpage_info[KVM_NR_PAGE_SIZES - 1];
115         unsigned long userspace_addr;
116         int user_alloc;
117 };
118
119 struct kvm_kernel_irq_routing_entry {
120         u32 gsi;
121         u32 type;
122         int (*set)(struct kvm_kernel_irq_routing_entry *e,
123                    struct kvm *kvm, int irq_source_id, int level);
124         union {
125                 struct {
126                         unsigned irqchip;
127                         unsigned pin;
128                 } irqchip;
129                 struct msi_msg msi;
130         };
131         struct hlist_node link;
132 };
133
134 struct kvm_irq_routing_table {
135         struct kvm_kernel_irq_routing_entry *rt_entries;
136         u32 nr_rt_entries;
137         /*
138          * Array indexed by gsi. Each entry contains list of irq chips
139          * the gsi is connected to.
140          */
141         struct hlist_head map[0];
142 };
143
144 struct kvm {
145         spinlock_t mmu_lock;
146         spinlock_t requests_lock;
147         struct rw_semaphore slots_lock;
148         struct mm_struct *mm; /* userspace tied to this vm */
149         int nmemslots;
150         struct kvm_memory_slot memslots[KVM_MEMORY_SLOTS +
151                                         KVM_PRIVATE_MEM_SLOTS];
152 #ifdef CONFIG_KVM_APIC_ARCHITECTURE
153         u32 bsp_vcpu_id;
154         struct kvm_vcpu *bsp_vcpu;
155 #endif
156         struct kvm_vcpu *vcpus[KVM_MAX_VCPUS];
157         atomic_t online_vcpus;
158         struct list_head vm_list;
159         struct mutex lock;
160         struct kvm_io_bus mmio_bus;
161         struct kvm_io_bus pio_bus;
162 #ifdef CONFIG_HAVE_KVM_EVENTFD
163         struct {
164                 spinlock_t        lock;
165                 struct list_head  items;
166         } irqfds;
167         struct list_head ioeventfds;
168 #endif
169         struct kvm_vm_stat stat;
170         struct kvm_arch arch;
171         atomic_t users_count;
172 #ifdef KVM_COALESCED_MMIO_PAGE_OFFSET
173         struct kvm_coalesced_mmio_dev *coalesced_mmio_dev;
174         struct kvm_coalesced_mmio_ring *coalesced_mmio_ring;
175 #endif
176
177         struct mutex irq_lock;
178 #ifdef CONFIG_HAVE_KVM_IRQCHIP
179         struct kvm_irq_routing_table *irq_routing;
180         struct hlist_head mask_notifier_list;
181 #endif
182
183 #ifdef KVM_ARCH_WANT_MMU_NOTIFIER
184         struct mmu_notifier mmu_notifier;
185         unsigned long mmu_notifier_seq;
186         long mmu_notifier_count;
187 #endif
188 };
189
190 /* The guest did something we don't support. */
191 #define pr_unimpl(vcpu, fmt, ...)                                       \
192  do {                                                                   \
193         if (printk_ratelimit())                                         \
194                 printk(KERN_ERR "kvm: %i: cpu%i " fmt,                  \
195                        current->tgid, (vcpu)->vcpu_id , ## __VA_ARGS__); \
196  } while (0)
197
198 #define kvm_printf(kvm, fmt ...) printk(KERN_DEBUG fmt)
199 #define vcpu_printf(vcpu, fmt...) kvm_printf(vcpu->kvm, fmt)
200
201 static inline struct kvm_vcpu *kvm_get_vcpu(struct kvm *kvm, int i)
202 {
203         smp_rmb();
204         return kvm->vcpus[i];
205 }
206
207 #define kvm_for_each_vcpu(idx, vcpup, kvm) \
208         for (idx = 0, vcpup = kvm_get_vcpu(kvm, idx); \
209              idx < atomic_read(&kvm->online_vcpus) && vcpup; \
210              vcpup = kvm_get_vcpu(kvm, ++idx))
211
212 int kvm_vcpu_init(struct kvm_vcpu *vcpu, struct kvm *kvm, unsigned id);
213 void kvm_vcpu_uninit(struct kvm_vcpu *vcpu);
214
215 void vcpu_load(struct kvm_vcpu *vcpu);
216 void vcpu_put(struct kvm_vcpu *vcpu);
217
218 int kvm_init(void *opaque, unsigned int vcpu_size,
219                   struct module *module);
220 void kvm_exit(void);
221
222 void kvm_get_kvm(struct kvm *kvm);
223 void kvm_put_kvm(struct kvm *kvm);
224
225 #define HPA_MSB ((sizeof(hpa_t) * 8) - 1)
226 #define HPA_ERR_MASK ((hpa_t)1 << HPA_MSB)
227 static inline int is_error_hpa(hpa_t hpa) { return hpa >> HPA_MSB; }
228 struct page *gva_to_page(struct kvm_vcpu *vcpu, gva_t gva);
229
230 extern struct page *bad_page;
231 extern pfn_t bad_pfn;
232
233 int is_error_page(struct page *page);
234 int is_error_pfn(pfn_t pfn);
235 int kvm_is_error_hva(unsigned long addr);
236 int kvm_set_memory_region(struct kvm *kvm,
237                           struct kvm_userspace_memory_region *mem,
238                           int user_alloc);
239 int __kvm_set_memory_region(struct kvm *kvm,
240                             struct kvm_userspace_memory_region *mem,
241                             int user_alloc);
242 int kvm_arch_set_memory_region(struct kvm *kvm,
243                                 struct kvm_userspace_memory_region *mem,
244                                 struct kvm_memory_slot old,
245                                 int user_alloc);
246 void kvm_disable_largepages(void);
247 void kvm_arch_flush_shadow(struct kvm *kvm);
248 gfn_t unalias_gfn(struct kvm *kvm, gfn_t gfn);
249 struct page *gfn_to_page(struct kvm *kvm, gfn_t gfn);
250 unsigned long gfn_to_hva(struct kvm *kvm, gfn_t gfn);
251 void kvm_release_page_clean(struct page *page);
252 void kvm_release_page_dirty(struct page *page);
253 void kvm_set_page_dirty(struct page *page);
254 void kvm_set_page_accessed(struct page *page);
255
256 pfn_t gfn_to_pfn(struct kvm *kvm, gfn_t gfn);
257 void kvm_release_pfn_dirty(pfn_t);
258 void kvm_release_pfn_clean(pfn_t pfn);
259 void kvm_set_pfn_dirty(pfn_t pfn);
260 void kvm_set_pfn_accessed(pfn_t pfn);
261 void kvm_get_pfn(pfn_t pfn);
262
263 int kvm_read_guest_page(struct kvm *kvm, gfn_t gfn, void *data, int offset,
264                         int len);
265 int kvm_read_guest_atomic(struct kvm *kvm, gpa_t gpa, void *data,
266                           unsigned long len);
267 int kvm_read_guest(struct kvm *kvm, gpa_t gpa, void *data, unsigned long len);
268 int kvm_write_guest_page(struct kvm *kvm, gfn_t gfn, const void *data,
269                          int offset, int len);
270 int kvm_write_guest(struct kvm *kvm, gpa_t gpa, const void *data,
271                     unsigned long len);
272 int kvm_clear_guest_page(struct kvm *kvm, gfn_t gfn, int offset, int len);
273 int kvm_clear_guest(struct kvm *kvm, gpa_t gpa, unsigned long len);
274 struct kvm_memory_slot *gfn_to_memslot(struct kvm *kvm, gfn_t gfn);
275 int kvm_is_visible_gfn(struct kvm *kvm, gfn_t gfn);
276 void mark_page_dirty(struct kvm *kvm, gfn_t gfn);
277
278 void kvm_vcpu_block(struct kvm_vcpu *vcpu);
279 void kvm_resched(struct kvm_vcpu *vcpu);
280 void kvm_load_guest_fpu(struct kvm_vcpu *vcpu);
281 void kvm_put_guest_fpu(struct kvm_vcpu *vcpu);
282 void kvm_flush_remote_tlbs(struct kvm *kvm);
283 void kvm_reload_remote_mmus(struct kvm *kvm);
284
285 long kvm_arch_dev_ioctl(struct file *filp,
286                         unsigned int ioctl, unsigned long arg);
287 long kvm_arch_vcpu_ioctl(struct file *filp,
288                          unsigned int ioctl, unsigned long arg);
289
290 int kvm_dev_ioctl_check_extension(long ext);
291
292 int kvm_get_dirty_log(struct kvm *kvm,
293                         struct kvm_dirty_log *log, int *is_dirty);
294 int kvm_vm_ioctl_get_dirty_log(struct kvm *kvm,
295                                 struct kvm_dirty_log *log);
296
297 int kvm_vm_ioctl_set_memory_region(struct kvm *kvm,
298                                    struct
299                                    kvm_userspace_memory_region *mem,
300                                    int user_alloc);
301 long kvm_arch_vm_ioctl(struct file *filp,
302                        unsigned int ioctl, unsigned long arg);
303
304 int kvm_arch_vcpu_ioctl_get_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
305 int kvm_arch_vcpu_ioctl_set_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
306
307 int kvm_arch_vcpu_ioctl_translate(struct kvm_vcpu *vcpu,
308                                     struct kvm_translation *tr);
309
310 int kvm_arch_vcpu_ioctl_get_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
311 int kvm_arch_vcpu_ioctl_set_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
312 int kvm_arch_vcpu_ioctl_get_sregs(struct kvm_vcpu *vcpu,
313                                   struct kvm_sregs *sregs);
314 int kvm_arch_vcpu_ioctl_set_sregs(struct kvm_vcpu *vcpu,
315                                   struct kvm_sregs *sregs);
316 int kvm_arch_vcpu_ioctl_get_mpstate(struct kvm_vcpu *vcpu,
317                                     struct kvm_mp_state *mp_state);
318 int kvm_arch_vcpu_ioctl_set_mpstate(struct kvm_vcpu *vcpu,
319                                     struct kvm_mp_state *mp_state);
320 int kvm_arch_vcpu_ioctl_set_guest_debug(struct kvm_vcpu *vcpu,
321                                         struct kvm_guest_debug *dbg);
322 int kvm_arch_vcpu_ioctl_run(struct kvm_vcpu *vcpu, struct kvm_run *kvm_run);
323
324 int kvm_arch_init(void *opaque);
325 void kvm_arch_exit(void);
326
327 int kvm_arch_vcpu_init(struct kvm_vcpu *vcpu);
328 void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu);
329
330 void kvm_arch_vcpu_free(struct kvm_vcpu *vcpu);
331 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
332 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
333 struct kvm_vcpu *kvm_arch_vcpu_create(struct kvm *kvm, unsigned int id);
334 int kvm_arch_vcpu_setup(struct kvm_vcpu *vcpu);
335 void kvm_arch_vcpu_destroy(struct kvm_vcpu *vcpu);
336
337 int kvm_arch_vcpu_reset(struct kvm_vcpu *vcpu);
338 void kvm_arch_hardware_enable(void *garbage);
339 void kvm_arch_hardware_disable(void *garbage);
340 int kvm_arch_hardware_setup(void);
341 void kvm_arch_hardware_unsetup(void);
342 void kvm_arch_check_processor_compat(void *rtn);
343 int kvm_arch_vcpu_runnable(struct kvm_vcpu *vcpu);
344
345 void kvm_free_physmem(struct kvm *kvm);
346
347 struct  kvm *kvm_arch_create_vm(void);
348 void kvm_arch_destroy_vm(struct kvm *kvm);
349 void kvm_free_all_assigned_devices(struct kvm *kvm);
350 void kvm_arch_sync_events(struct kvm *kvm);
351
352 int kvm_cpu_has_pending_timer(struct kvm_vcpu *vcpu);
353 void kvm_vcpu_kick(struct kvm_vcpu *vcpu);
354
355 int kvm_is_mmio_pfn(pfn_t pfn);
356
357 struct kvm_irq_ack_notifier {
358         struct hlist_node link;
359         unsigned gsi;
360         void (*irq_acked)(struct kvm_irq_ack_notifier *kian);
361 };
362
363 #define KVM_ASSIGNED_MSIX_PENDING               0x1
364 struct kvm_guest_msix_entry {
365         u32 vector;
366         u16 entry;
367         u16 flags;
368 };
369
370 struct kvm_assigned_dev_kernel {
371         struct kvm_irq_ack_notifier ack_notifier;
372         struct work_struct interrupt_work;
373         struct list_head list;
374         int assigned_dev_id;
375         int host_busnr;
376         int host_devfn;
377         unsigned int entries_nr;
378         int host_irq;
379         bool host_irq_disabled;
380         struct msix_entry *host_msix_entries;
381         int guest_irq;
382         struct kvm_guest_msix_entry *guest_msix_entries;
383         unsigned long irq_requested_type;
384         int irq_source_id;
385         int flags;
386         struct pci_dev *dev;
387         struct kvm *kvm;
388         spinlock_t assigned_dev_lock;
389 };
390
391 struct kvm_irq_mask_notifier {
392         void (*func)(struct kvm_irq_mask_notifier *kimn, bool masked);
393         int irq;
394         struct hlist_node link;
395 };
396
397 void kvm_register_irq_mask_notifier(struct kvm *kvm, int irq,
398                                     struct kvm_irq_mask_notifier *kimn);
399 void kvm_unregister_irq_mask_notifier(struct kvm *kvm, int irq,
400                                       struct kvm_irq_mask_notifier *kimn);
401 void kvm_fire_mask_notifiers(struct kvm *kvm, int irq, bool mask);
402
403 #ifdef __KVM_HAVE_IOAPIC
404 void kvm_get_intr_delivery_bitmask(struct kvm_ioapic *ioapic,
405                                    union kvm_ioapic_redirect_entry *entry,
406                                    unsigned long *deliver_bitmask);
407 #endif
408 int kvm_set_irq(struct kvm *kvm, int irq_source_id, u32 irq, int level);
409 void kvm_notify_acked_irq(struct kvm *kvm, unsigned irqchip, unsigned pin);
410 void kvm_register_irq_ack_notifier(struct kvm *kvm,
411                                    struct kvm_irq_ack_notifier *kian);
412 void kvm_unregister_irq_ack_notifier(struct kvm *kvm,
413                                    struct kvm_irq_ack_notifier *kian);
414 int kvm_request_irq_source_id(struct kvm *kvm);
415 void kvm_free_irq_source_id(struct kvm *kvm, int irq_source_id);
416
417 /* For vcpu->arch.iommu_flags */
418 #define KVM_IOMMU_CACHE_COHERENCY       0x1
419
420 #ifdef CONFIG_IOMMU_API
421 int kvm_iommu_map_pages(struct kvm *kvm, gfn_t base_gfn,
422                         unsigned long npages);
423 int kvm_iommu_map_guest(struct kvm *kvm);
424 int kvm_iommu_unmap_guest(struct kvm *kvm);
425 int kvm_assign_device(struct kvm *kvm,
426                       struct kvm_assigned_dev_kernel *assigned_dev);
427 int kvm_deassign_device(struct kvm *kvm,
428                         struct kvm_assigned_dev_kernel *assigned_dev);
429 #else /* CONFIG_IOMMU_API */
430 static inline int kvm_iommu_map_pages(struct kvm *kvm,
431                                       gfn_t base_gfn,
432                                       unsigned long npages)
433 {
434         return 0;
435 }
436
437 static inline int kvm_iommu_map_guest(struct kvm *kvm)
438 {
439         return -ENODEV;
440 }
441
442 static inline int kvm_iommu_unmap_guest(struct kvm *kvm)
443 {
444         return 0;
445 }
446
447 static inline int kvm_assign_device(struct kvm *kvm,
448                 struct kvm_assigned_dev_kernel *assigned_dev)
449 {
450         return 0;
451 }
452
453 static inline int kvm_deassign_device(struct kvm *kvm,
454                 struct kvm_assigned_dev_kernel *assigned_dev)
455 {
456         return 0;
457 }
458 #endif /* CONFIG_IOMMU_API */
459
460 static inline void kvm_guest_enter(void)
461 {
462         account_system_vtime(current);
463         current->flags |= PF_VCPU;
464 }
465
466 static inline void kvm_guest_exit(void)
467 {
468         account_system_vtime(current);
469         current->flags &= ~PF_VCPU;
470 }
471
472 static inline int memslot_id(struct kvm *kvm, struct kvm_memory_slot *slot)
473 {
474         return slot - kvm->memslots;
475 }
476
477 static inline gpa_t gfn_to_gpa(gfn_t gfn)
478 {
479         return (gpa_t)gfn << PAGE_SHIFT;
480 }
481
482 static inline hpa_t pfn_to_hpa(pfn_t pfn)
483 {
484         return (hpa_t)pfn << PAGE_SHIFT;
485 }
486
487 static inline void kvm_migrate_timers(struct kvm_vcpu *vcpu)
488 {
489         set_bit(KVM_REQ_MIGRATE_TIMER, &vcpu->requests);
490 }
491
492 enum kvm_stat_kind {
493         KVM_STAT_VM,
494         KVM_STAT_VCPU,
495 };
496
497 struct kvm_stats_debugfs_item {
498         const char *name;
499         int offset;
500         enum kvm_stat_kind kind;
501         struct dentry *dentry;
502 };
503 extern struct kvm_stats_debugfs_item debugfs_entries[];
504 extern struct dentry *kvm_debugfs_dir;
505
506 #ifdef KVM_ARCH_WANT_MMU_NOTIFIER
507 static inline int mmu_notifier_retry(struct kvm_vcpu *vcpu, unsigned long mmu_seq)
508 {
509         if (unlikely(vcpu->kvm->mmu_notifier_count))
510                 return 1;
511         /*
512          * Both reads happen under the mmu_lock and both values are
513          * modified under mmu_lock, so there's no need of smb_rmb()
514          * here in between, otherwise mmu_notifier_count should be
515          * read before mmu_notifier_seq, see
516          * mmu_notifier_invalidate_range_end write side.
517          */
518         if (vcpu->kvm->mmu_notifier_seq != mmu_seq)
519                 return 1;
520         return 0;
521 }
522 #endif
523
524 #ifdef CONFIG_HAVE_KVM_IRQCHIP
525
526 #define KVM_MAX_IRQ_ROUTES 1024
527
528 int kvm_setup_default_irq_routing(struct kvm *kvm);
529 int kvm_set_irq_routing(struct kvm *kvm,
530                         const struct kvm_irq_routing_entry *entries,
531                         unsigned nr,
532                         unsigned flags);
533 void kvm_free_irq_routing(struct kvm *kvm);
534
535 #else
536
537 static inline void kvm_free_irq_routing(struct kvm *kvm) {}
538
539 #endif
540
541 #ifdef CONFIG_HAVE_KVM_EVENTFD
542
543 void kvm_eventfd_init(struct kvm *kvm);
544 int kvm_irqfd(struct kvm *kvm, int fd, int gsi, int flags);
545 void kvm_irqfd_release(struct kvm *kvm);
546 int kvm_ioeventfd(struct kvm *kvm, struct kvm_ioeventfd *args);
547
548 #else
549
550 static inline void kvm_eventfd_init(struct kvm *kvm) {}
551 static inline int kvm_irqfd(struct kvm *kvm, int fd, int gsi, int flags)
552 {
553         return -EINVAL;
554 }
555
556 static inline void kvm_irqfd_release(struct kvm *kvm) {}
557 static inline int kvm_ioeventfd(struct kvm *kvm, struct kvm_ioeventfd *args)
558 {
559         return -ENOSYS;
560 }
561
562 #endif /* CONFIG_HAVE_KVM_EVENTFD */
563
564 #ifdef CONFIG_KVM_APIC_ARCHITECTURE
565 static inline bool kvm_vcpu_is_bsp(struct kvm_vcpu *vcpu)
566 {
567         return vcpu->kvm->bsp_vcpu_id == vcpu->vcpu_id;
568 }
569 #endif
570 #endif