drivers/kvm/kvm.h

   1 #ifndef __KVM_H
   2 #define __KVM_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 "types.h"
  24
  25 #include "x86.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
  39
  40 struct kvm_vcpu;
  41 extern struct kmem_cache *kvm_vcpu_cache;
  42
  43 struct kvm_guest_debug {
  44         int enabled;
  45         unsigned long bp[4];
  46         int singlestep;
  47 };
  48
  49 /*
  50  * It would be nice to use something smarter than a linear search, TBD...
  51  * Thankfully we dont expect many devices to register (famous last words :),
  52  * so until then it will suffice.  At least its abstracted so we can change
  53  * in one place.
  54  */
  55 struct kvm_io_bus {
  56         int                   dev_count;
  57 #define NR_IOBUS_DEVS 6
  58         struct kvm_io_device *devs[NR_IOBUS_DEVS];
  59 };
  60
  61 void kvm_io_bus_init(struct kvm_io_bus *bus);
  62 void kvm_io_bus_destroy(struct kvm_io_bus *bus);
  63 struct kvm_io_device *kvm_io_bus_find_dev(struct kvm_io_bus *bus, gpa_t addr);
  64 void kvm_io_bus_register_dev(struct kvm_io_bus *bus,
  65                              struct kvm_io_device *dev);
  66
  67 struct kvm_vcpu {
  68         struct kvm *kvm;
  69         struct preempt_notifier preempt_notifier;
  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         struct kvm_guest_debug 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         unsigned long userspace_addr;
 103         int user_alloc;
 104 };
 105
 106 struct kvm {
 107         struct mutex lock; /* protects everything except vcpus */
 108         struct mm_struct *mm; /* userspace tied to this vm */
 109         int nmemslots;
 110         struct kvm_memory_slot memslots[KVM_MEMORY_SLOTS +
 111                                         KVM_PRIVATE_MEM_SLOTS];
 112         struct kvm_vcpu *vcpus[KVM_MAX_VCPUS];
 113         struct list_head vm_list;
 114         struct file *filp;
 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 };
 120
 121 /* The guest did something we don't support. */
 122 #define pr_unimpl(vcpu, fmt, ...)                                       \
 123  do {                                                                   \
 124         if (printk_ratelimit())                                         \
 125                 printk(KERN_ERR "kvm: %i: cpu%i " fmt,                  \
 126                        current->tgid, (vcpu)->vcpu_id , ## __VA_ARGS__); \
 127  } while (0)
 128
 129 #define kvm_printf(kvm, fmt ...) printk(KERN_DEBUG fmt)
 130 #define vcpu_printf(vcpu, fmt...) kvm_printf(vcpu->kvm, fmt)
 131
 132 int kvm_vcpu_init(struct kvm_vcpu *vcpu, struct kvm *kvm, unsigned id);
 133 void kvm_vcpu_uninit(struct kvm_vcpu *vcpu);
 134
 135 void vcpu_load(struct kvm_vcpu *vcpu);
 136 void vcpu_put(struct kvm_vcpu *vcpu);
 137
 138 void decache_vcpus_on_cpu(int cpu);
 139
 140
 141 int kvm_init(void *opaque, unsigned int vcpu_size,
 142                   struct module *module);
 143 void kvm_exit(void);
 144
 145 #define HPA_MSB ((sizeof(hpa_t) * 8) - 1)
 146 #define HPA_ERR_MASK ((hpa_t)1 << HPA_MSB)
 147 static inline int is_error_hpa(hpa_t hpa) { return hpa >> HPA_MSB; }
 148 struct page *gva_to_page(struct kvm_vcpu *vcpu, gva_t gva);
 149
 150 extern struct page *bad_page;
 151
 152 int is_error_page(struct page *page);
 153 int kvm_is_error_hva(unsigned long addr);
 154 int kvm_set_memory_region(struct kvm *kvm,
 155                           struct kvm_userspace_memory_region *mem,
 156                           int user_alloc);
 157 int __kvm_set_memory_region(struct kvm *kvm,
 158                             struct kvm_userspace_memory_region *mem,
 159                             int user_alloc);
 160 int kvm_arch_set_memory_region(struct kvm *kvm,
 161                                 struct kvm_userspace_memory_region *mem,
 162                                 struct kvm_memory_slot old,
 163                                 int user_alloc);
 164 gfn_t unalias_gfn(struct kvm *kvm, gfn_t gfn);
 165 struct page *gfn_to_page(struct kvm *kvm, gfn_t gfn);
 166 void kvm_release_page_clean(struct page *page);
 167 void kvm_release_page_dirty(struct page *page);
 168 int kvm_read_guest_page(struct kvm *kvm, gfn_t gfn, void *data, int offset,
 169                         int len);
 170 int kvm_read_guest(struct kvm *kvm, gpa_t gpa, void *data, unsigned long len);
 171 int kvm_write_guest_page(struct kvm *kvm, gfn_t gfn, const void *data,
 172                          int offset, int len);
 173 int kvm_write_guest(struct kvm *kvm, gpa_t gpa, const void *data,
 174                     unsigned long len);
 175 int kvm_clear_guest_page(struct kvm *kvm, gfn_t gfn, int offset, int len);
 176 int kvm_clear_guest(struct kvm *kvm, gpa_t gpa, unsigned long len);
 177 struct kvm_memory_slot *gfn_to_memslot(struct kvm *kvm, gfn_t gfn);
 178 int kvm_is_visible_gfn(struct kvm *kvm, gfn_t gfn);
 179 void mark_page_dirty(struct kvm *kvm, gfn_t gfn);
 180
 181 void kvm_vcpu_block(struct kvm_vcpu *vcpu);
 182 void kvm_resched(struct kvm_vcpu *vcpu);
 183 void kvm_load_guest_fpu(struct kvm_vcpu *vcpu);
 184 void kvm_put_guest_fpu(struct kvm_vcpu *vcpu);
 185 void kvm_flush_remote_tlbs(struct kvm *kvm);
 186
 187 long kvm_arch_dev_ioctl(struct file *filp,
 188                         unsigned int ioctl, unsigned long arg);
 189 long kvm_arch_vcpu_ioctl(struct file *filp,
 190                          unsigned int ioctl, unsigned long arg);
 191 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
 192 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
 193
 194 int kvm_dev_ioctl_check_extension(long ext);
 195
 196 int kvm_get_dirty_log(struct kvm *kvm,
 197                         struct kvm_dirty_log *log, int *is_dirty);
 198 int kvm_vm_ioctl_get_dirty_log(struct kvm *kvm,
 199                                 struct kvm_dirty_log *log);
 200
 201 int kvm_vm_ioctl_set_memory_region(struct kvm *kvm,
 202                                    struct
 203                                    kvm_userspace_memory_region *mem,
 204                                    int user_alloc);
 205 long kvm_arch_vm_ioctl(struct file *filp,
 206                        unsigned int ioctl, unsigned long arg);
 207 void kvm_arch_destroy_vm(struct kvm *kvm);
 208
 209 int kvm_arch_vcpu_ioctl_get_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
 210 int kvm_arch_vcpu_ioctl_set_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
 211
 212 int kvm_arch_vcpu_ioctl_translate(struct kvm_vcpu *vcpu,
 213                                     struct kvm_translation *tr);
 214
 215 int kvm_arch_vcpu_ioctl_get_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
 216 int kvm_arch_vcpu_ioctl_set_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
 217 int kvm_arch_vcpu_ioctl_get_sregs(struct kvm_vcpu *vcpu,
 218                                   struct kvm_sregs *sregs);
 219 int kvm_arch_vcpu_ioctl_set_sregs(struct kvm_vcpu *vcpu,
 220                                   struct kvm_sregs *sregs);
 221 int kvm_arch_vcpu_ioctl_debug_guest(struct kvm_vcpu *vcpu,
 222                                     struct kvm_debug_guest *dbg);
 223 int kvm_arch_vcpu_ioctl_run(struct kvm_vcpu *vcpu, struct kvm_run *kvm_run);
 224
 225 int kvm_arch_init(void *opaque);
 226 void kvm_arch_exit(void);
 227
 228 int kvm_arch_vcpu_init(struct kvm_vcpu *vcpu);
 229 void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu);
 230
 231 void kvm_arch_vcpu_free(struct kvm_vcpu *vcpu);
 232 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
 233 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
 234 struct kvm_vcpu *kvm_arch_vcpu_create(struct kvm *kvm, unsigned int id);
 235 int kvm_arch_vcpu_setup(struct kvm_vcpu *vcpu);
 236 void kvm_arch_vcpu_destroy(struct kvm_vcpu *vcpu);
 237
 238 int kvm_arch_vcpu_reset(struct kvm_vcpu *vcpu);
 239 void kvm_arch_hardware_enable(void *garbage);
 240 void kvm_arch_hardware_disable(void *garbage);
 241 int kvm_arch_hardware_setup(void);
 242 void kvm_arch_hardware_unsetup(void);
 243 void kvm_arch_check_processor_compat(void *rtn);
 244 int kvm_arch_vcpu_runnable(struct kvm_vcpu *vcpu);
 245
 246 void kvm_free_physmem(struct kvm *kvm);
 247
 248 struct  kvm *kvm_arch_create_vm(void);
 249 void kvm_arch_destroy_vm(struct kvm *kvm);
 250
 251 int kvm_cpu_get_interrupt(struct kvm_vcpu *v);
 252 int kvm_cpu_has_interrupt(struct kvm_vcpu *v);
 253
 254 static inline void kvm_guest_enter(void)
 255 {
 256         account_system_vtime(current);
 257         current->flags |= PF_VCPU;
 258 }
 259
 260 static inline void kvm_guest_exit(void)
 261 {
 262         account_system_vtime(current);
 263         current->flags &= ~PF_VCPU;
 264 }
 265
 266 static inline int memslot_id(struct kvm *kvm, struct kvm_memory_slot *slot)
 267 {
 268         return slot - kvm->memslots;
 269 }
 270
 271 static inline gpa_t gfn_to_gpa(gfn_t gfn)
 272 {
 273         return (gpa_t)gfn << PAGE_SHIFT;
 274 }
 275
 276 enum kvm_stat_kind {
 277         KVM_STAT_VM,
 278         KVM_STAT_VCPU,
 279 };
 280
 281 struct kvm_stats_debugfs_item {
 282         const char *name;
 283         int offset;
 284         enum kvm_stat_kind kind;
 285         struct dentry *dentry;
 286 };
 287 extern struct kvm_stats_debugfs_item debugfs_entries[];
 288
 289 #endif