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/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 #define KVM_REQ_UNHALT             6
  38 #define KVM_REQ_MMU_SYNC           7
  39
  40 struct kvm_vcpu;
  41 extern struct kmem_cache *kvm_vcpu_cache;
  42
  43 /*
  44  * It would be nice to use something smarter than a linear search, TBD...
  45  * Thankfully we dont expect many devices to register (famous last words :),
  46  * so until then it will suffice.  At least its abstracted so we can change
  47  * in one place.
  48  */
  49 struct kvm_io_bus {
  50         int                   dev_count;
  51 #define NR_IOBUS_DEVS 6
  52         struct kvm_io_device *devs[NR_IOBUS_DEVS];
  53 };
  54
  55 void kvm_io_bus_init(struct kvm_io_bus *bus);
  56 void kvm_io_bus_destroy(struct kvm_io_bus *bus);
  57 struct kvm_io_device *kvm_io_bus_find_dev(struct kvm_io_bus *bus,
  58                                           gpa_t addr, int len, int is_write);
  59 void kvm_io_bus_register_dev(struct kvm_io_bus *bus,
  60                              struct kvm_io_device *dev);
  61
  62 struct kvm_vcpu {
  63         struct kvm *kvm;
  64 #ifdef CONFIG_PREEMPT_NOTIFIERS
  65         struct preempt_notifier preempt_notifier;
  66 #endif
  67         int vcpu_id;
  68         struct mutex mutex;
  69         int   cpu;
  70         struct kvm_run *run;
  71         int guest_mode;
  72         unsigned long requests;
  73         struct kvm_guest_debug guest_debug;
  74         int fpu_active;
  75         int guest_fpu_loaded;
  76         wait_queue_head_t wq;
  77         int sigset_active;
  78         sigset_t sigset;
  79         struct kvm_vcpu_stat stat;
  80
  81 #ifdef CONFIG_HAS_IOMEM
  82         int mmio_needed;
  83         int mmio_read_completed;
  84         int mmio_is_write;
  85         int mmio_size;
  86         unsigned char mmio_data[8];
  87         gpa_t mmio_phys_addr;
  88 #endif
  89
  90         struct kvm_vcpu_arch arch;
  91 };
  92
  93 struct kvm_memory_slot {
  94         gfn_t base_gfn;
  95         unsigned long npages;
  96         unsigned long flags;
  97         unsigned long *rmap;
  98         unsigned long *dirty_bitmap;
  99         struct {
 100                 unsigned long rmap_pde;
 101                 int write_count;
 102         } *lpage_info;
 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 kvm_io_bus mmio_bus;
 118         struct kvm_io_bus pio_bus;
 119         struct kvm_vm_stat stat;
 120         struct kvm_arch arch;
 121         atomic_t users_count;
 122 #ifdef KVM_COALESCED_MMIO_PAGE_OFFSET
 123         struct kvm_coalesced_mmio_dev *coalesced_mmio_dev;
 124         struct kvm_coalesced_mmio_ring *coalesced_mmio_ring;
 125 #endif
 126
 127 #ifdef KVM_ARCH_WANT_MMU_NOTIFIER
 128         struct mmu_notifier mmu_notifier;
 129         unsigned long mmu_notifier_seq;
 130         long mmu_notifier_count;
 131 #endif
 132 };
 133
 134 /* The guest did something we don't support. */
 135 #define pr_unimpl(vcpu, fmt, ...)                                       \
 136  do {                                                                   \
 137         if (printk_ratelimit())                                         \
 138                 printk(KERN_ERR "kvm: %i: cpu%i " fmt,                  \
 139                        current->tgid, (vcpu)->vcpu_id , ## __VA_ARGS__); \
 140  } while (0)
 141
 142 #define kvm_printf(kvm, fmt ...) printk(KERN_DEBUG fmt)
 143 #define vcpu_printf(vcpu, fmt...) kvm_printf(vcpu->kvm, fmt)
 144
 145 int kvm_vcpu_init(struct kvm_vcpu *vcpu, struct kvm *kvm, unsigned id);
 146 void kvm_vcpu_uninit(struct kvm_vcpu *vcpu);
 147
 148 void vcpu_load(struct kvm_vcpu *vcpu);
 149 void vcpu_put(struct kvm_vcpu *vcpu);
 150
 151 int kvm_init(void *opaque, unsigned int vcpu_size,
 152                   struct module *module);
 153 void kvm_exit(void);
 154
 155 void kvm_get_kvm(struct kvm *kvm);
 156 void kvm_put_kvm(struct kvm *kvm);
 157
 158 #define HPA_MSB ((sizeof(hpa_t) * 8) - 1)
 159 #define HPA_ERR_MASK ((hpa_t)1 << HPA_MSB)
 160 static inline int is_error_hpa(hpa_t hpa) { return hpa >> HPA_MSB; }
 161 struct page *gva_to_page(struct kvm_vcpu *vcpu, gva_t gva);
 162
 163 extern struct page *bad_page;
 164 extern pfn_t bad_pfn;
 165
 166 int is_error_page(struct page *page);
 167 int is_error_pfn(pfn_t pfn);
 168 int kvm_is_error_hva(unsigned long addr);
 169 int kvm_set_memory_region(struct kvm *kvm,
 170                           struct kvm_userspace_memory_region *mem,
 171                           int user_alloc);
 172 int __kvm_set_memory_region(struct kvm *kvm,
 173                             struct kvm_userspace_memory_region *mem,
 174                             int user_alloc);
 175 int kvm_arch_set_memory_region(struct kvm *kvm,
 176                                 struct kvm_userspace_memory_region *mem,
 177                                 struct kvm_memory_slot old,
 178                                 int user_alloc);
 179 void kvm_arch_flush_shadow(struct kvm *kvm);
 180 gfn_t unalias_gfn(struct kvm *kvm, gfn_t gfn);
 181 struct page *gfn_to_page(struct kvm *kvm, gfn_t gfn);
 182 unsigned long gfn_to_hva(struct kvm *kvm, gfn_t gfn);
 183 void kvm_release_page_clean(struct page *page);
 184 void kvm_release_page_dirty(struct page *page);
 185 void kvm_set_page_dirty(struct page *page);
 186 void kvm_set_page_accessed(struct page *page);
 187
 188 pfn_t gfn_to_pfn(struct kvm *kvm, gfn_t gfn);
 189 void kvm_release_pfn_dirty(pfn_t);
 190 void kvm_release_pfn_clean(pfn_t pfn);
 191 void kvm_set_pfn_dirty(pfn_t pfn);
 192 void kvm_set_pfn_accessed(pfn_t pfn);
 193 void kvm_get_pfn(pfn_t pfn);
 194
 195 int kvm_read_guest_page(struct kvm *kvm, gfn_t gfn, void *data, int offset,
 196                         int len);
 197 int kvm_read_guest_atomic(struct kvm *kvm, gpa_t gpa, void *data,
 198                           unsigned long len);
 199 int kvm_read_guest(struct kvm *kvm, gpa_t gpa, void *data, unsigned long len);
 200 int kvm_write_guest_page(struct kvm *kvm, gfn_t gfn, const void *data,
 201                          int offset, int len);
 202 int kvm_write_guest(struct kvm *kvm, gpa_t gpa, const void *data,
 203                     unsigned long len);
 204 int kvm_clear_guest_page(struct kvm *kvm, gfn_t gfn, int offset, int len);
 205 int kvm_clear_guest(struct kvm *kvm, gpa_t gpa, unsigned long len);
 206 struct kvm_memory_slot *gfn_to_memslot(struct kvm *kvm, gfn_t gfn);
 207 int kvm_is_visible_gfn(struct kvm *kvm, gfn_t gfn);
 208 void mark_page_dirty(struct kvm *kvm, gfn_t gfn);
 209
 210 void kvm_vcpu_block(struct kvm_vcpu *vcpu);
 211 void kvm_resched(struct kvm_vcpu *vcpu);
 212 void kvm_load_guest_fpu(struct kvm_vcpu *vcpu);
 213 void kvm_put_guest_fpu(struct kvm_vcpu *vcpu);
 214 void kvm_flush_remote_tlbs(struct kvm *kvm);
 215 void kvm_reload_remote_mmus(struct kvm *kvm);
 216
 217 long kvm_arch_dev_ioctl(struct file *filp,
 218                         unsigned int ioctl, unsigned long arg);
 219 long kvm_arch_vcpu_ioctl(struct file *filp,
 220                          unsigned int ioctl, unsigned long arg);
 221 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
 222 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
 223
 224 int kvm_dev_ioctl_check_extension(long ext);
 225
 226 int kvm_get_dirty_log(struct kvm *kvm,
 227                         struct kvm_dirty_log *log, int *is_dirty);
 228 int kvm_vm_ioctl_get_dirty_log(struct kvm *kvm,
 229                                 struct kvm_dirty_log *log);
 230
 231 int kvm_vm_ioctl_set_memory_region(struct kvm *kvm,
 232                                    struct
 233                                    kvm_userspace_memory_region *mem,
 234                                    int user_alloc);
 235 long kvm_arch_vm_ioctl(struct file *filp,
 236                        unsigned int ioctl, unsigned long arg);
 237 void kvm_arch_destroy_vm(struct kvm *kvm);
 238
 239 int kvm_arch_vcpu_ioctl_get_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
 240 int kvm_arch_vcpu_ioctl_set_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
 241
 242 int kvm_arch_vcpu_ioctl_translate(struct kvm_vcpu *vcpu,
 243                                     struct kvm_translation *tr);
 244
 245 int kvm_arch_vcpu_ioctl_get_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
 246 int kvm_arch_vcpu_ioctl_set_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
 247 int kvm_arch_vcpu_ioctl_get_sregs(struct kvm_vcpu *vcpu,
 248                                   struct kvm_sregs *sregs);
 249 int kvm_arch_vcpu_ioctl_set_sregs(struct kvm_vcpu *vcpu,
 250                                   struct kvm_sregs *sregs);
 251 int kvm_arch_vcpu_ioctl_get_mpstate(struct kvm_vcpu *vcpu,
 252                                     struct kvm_mp_state *mp_state);
 253 int kvm_arch_vcpu_ioctl_set_mpstate(struct kvm_vcpu *vcpu,
 254                                     struct kvm_mp_state *mp_state);
 255 int kvm_arch_vcpu_ioctl_debug_guest(struct kvm_vcpu *vcpu,
 256                                     struct kvm_debug_guest *dbg);
 257 int kvm_arch_vcpu_ioctl_run(struct kvm_vcpu *vcpu, struct kvm_run *kvm_run);
 258
 259 int kvm_arch_init(void *opaque);
 260 void kvm_arch_exit(void);
 261
 262 int kvm_arch_vcpu_init(struct kvm_vcpu *vcpu);
 263 void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu);
 264
 265 void kvm_arch_vcpu_free(struct kvm_vcpu *vcpu);
 266 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
 267 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
 268 struct kvm_vcpu *kvm_arch_vcpu_create(struct kvm *kvm, unsigned int id);
 269 int kvm_arch_vcpu_setup(struct kvm_vcpu *vcpu);
 270 void kvm_arch_vcpu_destroy(struct kvm_vcpu *vcpu);
 271
 272 int kvm_arch_vcpu_reset(struct kvm_vcpu *vcpu);
 273 void kvm_arch_hardware_enable(void *garbage);
 274 void kvm_arch_hardware_disable(void *garbage);
 275 int kvm_arch_hardware_setup(void);
 276 void kvm_arch_hardware_unsetup(void);
 277 void kvm_arch_check_processor_compat(void *rtn);
 278 int kvm_arch_vcpu_runnable(struct kvm_vcpu *vcpu);
 279
 280 void kvm_free_physmem(struct kvm *kvm);
 281
 282 struct  kvm *kvm_arch_create_vm(void);
 283 void kvm_arch_destroy_vm(struct kvm *kvm);
 284 void kvm_free_all_assigned_devices(struct kvm *kvm);
 285
 286 int kvm_cpu_get_interrupt(struct kvm_vcpu *v);
 287 int kvm_cpu_has_interrupt(struct kvm_vcpu *v);
 288 int kvm_cpu_has_pending_timer(struct kvm_vcpu *vcpu);
 289 void kvm_vcpu_kick(struct kvm_vcpu *vcpu);
 290
 291 int kvm_is_mmio_pfn(pfn_t pfn);
 292
 293 struct kvm_irq_ack_notifier {
 294         struct hlist_node link;
 295         unsigned gsi;
 296         void (*irq_acked)(struct kvm_irq_ack_notifier *kian);
 297 };
 298
 299 struct kvm_assigned_dev_kernel {
 300         struct kvm_irq_ack_notifier ack_notifier;
 301         struct work_struct interrupt_work;
 302         struct list_head list;
 303         int assigned_dev_id;
 304         int host_busnr;
 305         int host_devfn;
 306         int host_irq;
 307         int guest_irq;
 308         int irq_requested;
 309         struct pci_dev *dev;
 310         struct kvm *kvm;
 311 };
 312 void kvm_set_irq(struct kvm *kvm, int irq, int level);
 313 void kvm_notify_acked_irq(struct kvm *kvm, unsigned gsi);
 314 void kvm_register_irq_ack_notifier(struct kvm *kvm,
 315                                    struct kvm_irq_ack_notifier *kian);
 316 void kvm_unregister_irq_ack_notifier(struct kvm *kvm,
 317                                      struct kvm_irq_ack_notifier *kian);
 318
 319 #ifdef CONFIG_DMAR
 320 int kvm_iommu_map_pages(struct kvm *kvm, gfn_t base_gfn,
 321                         unsigned long npages);
 322 int kvm_iommu_map_guest(struct kvm *kvm,
 323                         struct kvm_assigned_dev_kernel *assigned_dev);
 324 int kvm_iommu_unmap_guest(struct kvm *kvm);
 325 #else /* CONFIG_DMAR */
 326 static inline int kvm_iommu_map_pages(struct kvm *kvm,
 327                                       gfn_t base_gfn,
 328                                       unsigned long npages)
 329 {
 330         return 0;
 331 }
 332
 333 static inline int kvm_iommu_map_guest(struct kvm *kvm,
 334                                       struct kvm_assigned_dev_kernel
 335                                       *assigned_dev)
 336 {
 337         return -ENODEV;
 338 }
 339
 340 static inline int kvm_iommu_unmap_guest(struct kvm *kvm)
 341 {
 342         return 0;
 343 }
 344 #endif /* CONFIG_DMAR */
 345
 346 static inline void kvm_guest_enter(void)
 347 {
 348         account_system_vtime(current);
 349         current->flags |= PF_VCPU;
 350 }
 351
 352 static inline void kvm_guest_exit(void)
 353 {
 354         account_system_vtime(current);
 355         current->flags &= ~PF_VCPU;
 356 }
 357
 358 static inline int memslot_id(struct kvm *kvm, struct kvm_memory_slot *slot)
 359 {
 360         return slot - kvm->memslots;
 361 }
 362
 363 static inline gpa_t gfn_to_gpa(gfn_t gfn)
 364 {
 365         return (gpa_t)gfn << PAGE_SHIFT;
 366 }
 367
 368 static inline hpa_t pfn_to_hpa(pfn_t pfn)
 369 {
 370         return (hpa_t)pfn << PAGE_SHIFT;
 371 }
 372
 373 static inline void kvm_migrate_timers(struct kvm_vcpu *vcpu)
 374 {
 375         set_bit(KVM_REQ_MIGRATE_TIMER, &vcpu->requests);
 376 }
 377
 378 enum kvm_stat_kind {
 379         KVM_STAT_VM,
 380         KVM_STAT_VCPU,
 381 };
 382
 383 struct kvm_stats_debugfs_item {
 384         const char *name;
 385         int offset;
 386         enum kvm_stat_kind kind;
 387         struct dentry *dentry;
 388 };
 389 extern struct kvm_stats_debugfs_item debugfs_entries[];
 390 extern struct dentry *kvm_debugfs_dir;
 391
 392 #define KVMTRACE_5D(evt, vcpu, d1, d2, d3, d4, d5, name) \
 393         trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
 394                                                 vcpu, 5, d1, d2, d3, d4, d5)
 395 #define KVMTRACE_4D(evt, vcpu, d1, d2, d3, d4, name) \
 396         trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
 397                                                 vcpu, 4, d1, d2, d3, d4, 0)
 398 #define KVMTRACE_3D(evt, vcpu, d1, d2, d3, name) \
 399         trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
 400                                                 vcpu, 3, d1, d2, d3, 0, 0)
 401 #define KVMTRACE_2D(evt, vcpu, d1, d2, name) \
 402         trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
 403                                                 vcpu, 2, d1, d2, 0, 0, 0)
 404 #define KVMTRACE_1D(evt, vcpu, d1, name) \
 405         trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
 406                                                 vcpu, 1, d1, 0, 0, 0, 0)
 407 #define KVMTRACE_0D(evt, vcpu, name) \
 408         trace_mark(kvm_trace_##name, "%u %p %u %u %u %u %u %u", KVM_TRC_##evt, \
 409                                                 vcpu, 0, 0, 0, 0, 0, 0)
 410
 411 #ifdef CONFIG_KVM_TRACE
 412 int kvm_trace_ioctl(unsigned int ioctl, unsigned long arg);
 413 void kvm_trace_cleanup(void);
 414 #else
 415 static inline
 416 int kvm_trace_ioctl(unsigned int ioctl, unsigned long arg)
 417 {
 418         return -EINVAL;
 419 }
 420 #define kvm_trace_cleanup() ((void)0)
 421 #endif
 422
 423 #ifdef KVM_ARCH_WANT_MMU_NOTIFIER
 424 static inline int mmu_notifier_retry(struct kvm_vcpu *vcpu, unsigned long mmu_seq)
 425 {
 426         if (unlikely(vcpu->kvm->mmu_notifier_count))
 427                 return 1;
 428         /*
 429          * Both reads happen under the mmu_lock and both values are
 430          * modified under mmu_lock, so there's no need of smb_rmb()
 431          * here in between, otherwise mmu_notifier_count should be
 432          * read before mmu_notifier_seq, see
 433          * mmu_notifier_invalidate_range_end write side.
 434          */
 435         if (vcpu->kvm->mmu_notifier_seq != mmu_seq)
 436                 return 1;
 437         return 0;
 438 }
 439 #endif
 440
 441 #endif