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