feffbdaf898681f68c5c8428a1b9b1fb4ea969ed
[linux-3.10.git] / include / linux / kvm_host.h
1 #ifndef __KVM_HOST_H
2 #define __KVM_HOST_H
3
4 #if IS_ENABLED(CONFIG_KVM)
5
6 /*
7  * This work is licensed under the terms of the GNU GPL, version 2.  See
8  * the COPYING file in the top-level directory.
9  */
10
11 #include <linux/types.h>
12 #include <linux/hardirq.h>
13 #include <linux/list.h>
14 #include <linux/mutex.h>
15 #include <linux/spinlock.h>
16 #include <linux/signal.h>
17 #include <linux/sched.h>
18 #include <linux/bug.h>
19 #include <linux/mm.h>
20 #include <linux/mmu_notifier.h>
21 #include <linux/preempt.h>
22 #include <linux/msi.h>
23 #include <linux/slab.h>
24 #include <linux/rcupdate.h>
25 #include <linux/ratelimit.h>
26 #include <linux/err.h>
27 #include <linux/irqflags.h>
28 #include <asm/signal.h>
29
30 #include <linux/kvm.h>
31 #include <linux/kvm_para.h>
32
33 #include <linux/kvm_types.h>
34
35 #include <asm/kvm_host.h>
36
37 #ifndef KVM_MMIO_SIZE
38 #define KVM_MMIO_SIZE 8
39 #endif
40
41 /*
42  * The bit 16 ~ bit 31 of kvm_memory_region::flags are internally used
43  * in kvm, other bits are visible for userspace which are defined in
44  * include/linux/kvm_h.
45  */
46 #define KVM_MEMSLOT_INVALID     (1UL << 16)
47
48 /* Two fragments for cross MMIO pages. */
49 #define KVM_MAX_MMIO_FRAGMENTS  2
50
51 /*
52  * For the normal pfn, the highest 12 bits should be zero,
53  * so we can mask bit 62 ~ bit 52  to indicate the error pfn,
54  * mask bit 63 to indicate the noslot pfn.
55  */
56 #define KVM_PFN_ERR_MASK        (0x7ffULL << 52)
57 #define KVM_PFN_ERR_NOSLOT_MASK (0xfffULL << 52)
58 #define KVM_PFN_NOSLOT          (0x1ULL << 63)
59
60 #define KVM_PFN_ERR_FAULT       (KVM_PFN_ERR_MASK)
61 #define KVM_PFN_ERR_HWPOISON    (KVM_PFN_ERR_MASK + 1)
62 #define KVM_PFN_ERR_RO_FAULT    (KVM_PFN_ERR_MASK + 2)
63
64 /*
65  * error pfns indicate that the gfn is in slot but faild to
66  * translate it to pfn on host.
67  */
68 static inline bool is_error_pfn(pfn_t pfn)
69 {
70         return !!(pfn & KVM_PFN_ERR_MASK);
71 }
72
73 /*
74  * error_noslot pfns indicate that the gfn can not be
75  * translated to pfn - it is not in slot or failed to
76  * translate it to pfn.
77  */
78 static inline bool is_error_noslot_pfn(pfn_t pfn)
79 {
80         return !!(pfn & KVM_PFN_ERR_NOSLOT_MASK);
81 }
82
83 /* noslot pfn indicates that the gfn is not in slot. */
84 static inline bool is_noslot_pfn(pfn_t pfn)
85 {
86         return pfn == KVM_PFN_NOSLOT;
87 }
88
89 #define KVM_HVA_ERR_BAD         (PAGE_OFFSET)
90 #define KVM_HVA_ERR_RO_BAD      (PAGE_OFFSET + PAGE_SIZE)
91
92 static inline bool kvm_is_error_hva(unsigned long addr)
93 {
94         return addr >= PAGE_OFFSET;
95 }
96
97 #define KVM_ERR_PTR_BAD_PAGE    (ERR_PTR(-ENOENT))
98
99 static inline bool is_error_page(struct page *page)
100 {
101         return IS_ERR(page);
102 }
103
104 /*
105  * vcpu->requests bit members
106  */
107 #define KVM_REQ_TLB_FLUSH          0
108 #define KVM_REQ_MIGRATE_TIMER      1
109 #define KVM_REQ_REPORT_TPR_ACCESS  2
110 #define KVM_REQ_MMU_RELOAD         3
111 #define KVM_REQ_TRIPLE_FAULT       4
112 #define KVM_REQ_PENDING_TIMER      5
113 #define KVM_REQ_UNHALT             6
114 #define KVM_REQ_MMU_SYNC           7
115 #define KVM_REQ_CLOCK_UPDATE       8
116 #define KVM_REQ_KICK               9
117 #define KVM_REQ_DEACTIVATE_FPU    10
118 #define KVM_REQ_EVENT             11
119 #define KVM_REQ_APF_HALT          12
120 #define KVM_REQ_STEAL_UPDATE      13
121 #define KVM_REQ_NMI               14
122 #define KVM_REQ_IMMEDIATE_EXIT    15
123 #define KVM_REQ_PMU               16
124 #define KVM_REQ_PMI               17
125 #define KVM_REQ_WATCHDOG          18
126 #define KVM_REQ_MASTERCLOCK_UPDATE 19
127 #define KVM_REQ_MCLOCK_INPROGRESS 20
128 #define KVM_REQ_EPR_EXIT          21
129 #define KVM_REQ_SCAN_IOAPIC       22
130
131 #define KVM_USERSPACE_IRQ_SOURCE_ID             0
132 #define KVM_IRQFD_RESAMPLE_IRQ_SOURCE_ID        1
133
134 struct kvm;
135 struct kvm_vcpu;
136 extern struct kmem_cache *kvm_vcpu_cache;
137
138 extern raw_spinlock_t kvm_lock;
139 extern struct list_head vm_list;
140
141 struct kvm_io_range {
142         gpa_t addr;
143         int len;
144         struct kvm_io_device *dev;
145 };
146
147 #define NR_IOBUS_DEVS 1000
148
149 struct kvm_io_bus {
150         int                   dev_count;
151         struct kvm_io_range range[];
152 };
153
154 enum kvm_bus {
155         KVM_MMIO_BUS,
156         KVM_PIO_BUS,
157         KVM_VIRTIO_CCW_NOTIFY_BUS,
158         KVM_NR_BUSES
159 };
160
161 int kvm_io_bus_write(struct kvm *kvm, enum kvm_bus bus_idx, gpa_t addr,
162                      int len, const void *val);
163 int kvm_io_bus_read(struct kvm *kvm, enum kvm_bus bus_idx, gpa_t addr, int len,
164                     void *val);
165 int kvm_io_bus_register_dev(struct kvm *kvm, enum kvm_bus bus_idx, gpa_t addr,
166                             int len, struct kvm_io_device *dev);
167 int kvm_io_bus_unregister_dev(struct kvm *kvm, enum kvm_bus bus_idx,
168                               struct kvm_io_device *dev);
169
170 #ifdef CONFIG_KVM_ASYNC_PF
171 struct kvm_async_pf {
172         struct work_struct work;
173         struct list_head link;
174         struct list_head queue;
175         struct kvm_vcpu *vcpu;
176         struct mm_struct *mm;
177         gva_t gva;
178         unsigned long addr;
179         struct kvm_arch_async_pf arch;
180         struct page *page;
181         bool done;
182 };
183
184 void kvm_clear_async_pf_completion_queue(struct kvm_vcpu *vcpu);
185 void kvm_check_async_pf_completion(struct kvm_vcpu *vcpu);
186 int kvm_setup_async_pf(struct kvm_vcpu *vcpu, gva_t gva, gfn_t gfn,
187                        struct kvm_arch_async_pf *arch);
188 int kvm_async_pf_wakeup_all(struct kvm_vcpu *vcpu);
189 #endif
190
191 enum {
192         OUTSIDE_GUEST_MODE,
193         IN_GUEST_MODE,
194         EXITING_GUEST_MODE,
195         READING_SHADOW_PAGE_TABLES,
196 };
197
198 /*
199  * Sometimes a large or cross-page mmio needs to be broken up into separate
200  * exits for userspace servicing.
201  */
202 struct kvm_mmio_fragment {
203         gpa_t gpa;
204         void *data;
205         unsigned len;
206 };
207
208 struct kvm_vcpu {
209         struct kvm *kvm;
210 #ifdef CONFIG_PREEMPT_NOTIFIERS
211         struct preempt_notifier preempt_notifier;
212 #endif
213         int cpu;
214         int vcpu_id;
215         int srcu_idx;
216         int mode;
217         unsigned long requests;
218         unsigned long guest_debug;
219
220         struct mutex mutex;
221         struct kvm_run *run;
222
223         int fpu_active;
224         int guest_fpu_loaded, guest_xcr0_loaded;
225         wait_queue_head_t wq;
226         struct pid *pid;
227         int sigset_active;
228         sigset_t sigset;
229         struct kvm_vcpu_stat stat;
230
231 #ifdef CONFIG_HAS_IOMEM
232         int mmio_needed;
233         int mmio_read_completed;
234         int mmio_is_write;
235         int mmio_cur_fragment;
236         int mmio_nr_fragments;
237         struct kvm_mmio_fragment mmio_fragments[KVM_MAX_MMIO_FRAGMENTS];
238 #endif
239
240 #ifdef CONFIG_KVM_ASYNC_PF
241         struct {
242                 u32 queued;
243                 struct list_head queue;
244                 struct list_head done;
245                 spinlock_t lock;
246         } async_pf;
247 #endif
248
249 #ifdef CONFIG_HAVE_KVM_CPU_RELAX_INTERCEPT
250         /*
251          * Cpu relax intercept or pause loop exit optimization
252          * in_spin_loop: set when a vcpu does a pause loop exit
253          *  or cpu relax intercepted.
254          * dy_eligible: indicates whether vcpu is eligible for directed yield.
255          */
256         struct {
257                 bool in_spin_loop;
258                 bool dy_eligible;
259         } spin_loop;
260 #endif
261         bool preempted;
262         struct kvm_vcpu_arch arch;
263 };
264
265 static inline int kvm_vcpu_exiting_guest_mode(struct kvm_vcpu *vcpu)
266 {
267         return cmpxchg(&vcpu->mode, IN_GUEST_MODE, EXITING_GUEST_MODE);
268 }
269
270 /*
271  * Some of the bitops functions do not support too long bitmaps.
272  * This number must be determined not to exceed such limits.
273  */
274 #define KVM_MEM_MAX_NR_PAGES ((1UL << 31) - 1)
275
276 struct kvm_memory_slot {
277         gfn_t base_gfn;
278         unsigned long npages;
279         unsigned long *dirty_bitmap;
280         struct kvm_arch_memory_slot arch;
281         unsigned long userspace_addr;
282         u32 flags;
283         short id;
284 };
285
286 static inline unsigned long kvm_dirty_bitmap_bytes(struct kvm_memory_slot *memslot)
287 {
288         return ALIGN(memslot->npages, BITS_PER_LONG) / 8;
289 }
290
291 struct kvm_kernel_irq_routing_entry {
292         u32 gsi;
293         u32 type;
294         int (*set)(struct kvm_kernel_irq_routing_entry *e,
295                    struct kvm *kvm, int irq_source_id, int level,
296                    bool line_status);
297         union {
298                 struct {
299                         unsigned irqchip;
300                         unsigned pin;
301                 } irqchip;
302                 struct msi_msg msi;
303         };
304         struct hlist_node link;
305 };
306
307 #ifdef CONFIG_HAVE_KVM_IRQ_ROUTING
308
309 struct kvm_irq_routing_table {
310         int chip[KVM_NR_IRQCHIPS][KVM_IRQCHIP_NUM_PINS];
311         struct kvm_kernel_irq_routing_entry *rt_entries;
312         u32 nr_rt_entries;
313         /*
314          * Array indexed by gsi. Each entry contains list of irq chips
315          * the gsi is connected to.
316          */
317         struct hlist_head map[0];
318 };
319
320 #else
321
322 struct kvm_irq_routing_table {};
323
324 #endif
325
326 #ifndef KVM_PRIVATE_MEM_SLOTS
327 #define KVM_PRIVATE_MEM_SLOTS 0
328 #endif
329
330 #ifndef KVM_MEM_SLOTS_NUM
331 #define KVM_MEM_SLOTS_NUM (KVM_USER_MEM_SLOTS + KVM_PRIVATE_MEM_SLOTS)
332 #endif
333
334 /*
335  * Note:
336  * memslots are not sorted by id anymore, please use id_to_memslot()
337  * to get the memslot by its id.
338  */
339 struct kvm_memslots {
340         u64 generation;
341         struct kvm_memory_slot memslots[KVM_MEM_SLOTS_NUM];
342         /* The mapping table from slot id to the index in memslots[]. */
343         short id_to_index[KVM_MEM_SLOTS_NUM];
344 };
345
346 struct kvm {
347         spinlock_t mmu_lock;
348         struct mutex slots_lock;
349         struct mm_struct *mm; /* userspace tied to this vm */
350         struct kvm_memslots *memslots;
351         struct srcu_struct srcu;
352 #ifdef CONFIG_KVM_APIC_ARCHITECTURE
353         u32 bsp_vcpu_id;
354 #endif
355         struct kvm_vcpu *vcpus[KVM_MAX_VCPUS];
356         atomic_t online_vcpus;
357         int last_boosted_vcpu;
358         struct list_head vm_list;
359         struct mutex lock;
360         struct kvm_io_bus *buses[KVM_NR_BUSES];
361 #ifdef CONFIG_HAVE_KVM_EVENTFD
362         struct {
363                 spinlock_t        lock;
364                 struct list_head  items;
365                 struct list_head  resampler_list;
366                 struct mutex      resampler_lock;
367         } irqfds;
368         struct list_head ioeventfds;
369 #endif
370         struct kvm_vm_stat stat;
371         struct kvm_arch arch;
372         atomic_t users_count;
373 #ifdef KVM_COALESCED_MMIO_PAGE_OFFSET
374         struct kvm_coalesced_mmio_ring *coalesced_mmio_ring;
375         spinlock_t ring_lock;
376         struct list_head coalesced_zones;
377 #endif
378
379         struct mutex irq_lock;
380 #ifdef CONFIG_HAVE_KVM_IRQCHIP
381         /*
382          * Update side is protected by irq_lock and,
383          * if configured, irqfds.lock.
384          */
385         struct kvm_irq_routing_table __rcu *irq_routing;
386         struct hlist_head mask_notifier_list;
387         struct hlist_head irq_ack_notifier_list;
388 #endif
389
390 #if defined(CONFIG_MMU_NOTIFIER) && defined(KVM_ARCH_WANT_MMU_NOTIFIER)
391         struct mmu_notifier mmu_notifier;
392         unsigned long mmu_notifier_seq;
393         long mmu_notifier_count;
394 #endif
395         long tlbs_dirty;
396 };
397
398 #define kvm_err(fmt, ...) \
399         pr_err("kvm [%i]: " fmt, task_pid_nr(current), ## __VA_ARGS__)
400 #define kvm_info(fmt, ...) \
401         pr_info("kvm [%i]: " fmt, task_pid_nr(current), ## __VA_ARGS__)
402 #define kvm_debug(fmt, ...) \
403         pr_debug("kvm [%i]: " fmt, task_pid_nr(current), ## __VA_ARGS__)
404 #define kvm_pr_unimpl(fmt, ...) \
405         pr_err_ratelimited("kvm [%i]: " fmt, \
406                            task_tgid_nr(current), ## __VA_ARGS__)
407
408 /* The guest did something we don't support. */
409 #define vcpu_unimpl(vcpu, fmt, ...)                                     \
410         kvm_pr_unimpl("vcpu%i " fmt, (vcpu)->vcpu_id, ## __VA_ARGS__)
411
412 static inline struct kvm_vcpu *kvm_get_vcpu(struct kvm *kvm, int i)
413 {
414         smp_rmb();
415         return kvm->vcpus[i];
416 }
417
418 #define kvm_for_each_vcpu(idx, vcpup, kvm) \
419         for (idx = 0; \
420              idx < atomic_read(&kvm->online_vcpus) && \
421              (vcpup = kvm_get_vcpu(kvm, idx)) != NULL; \
422              idx++)
423
424 #define kvm_for_each_memslot(memslot, slots)    \
425         for (memslot = &slots->memslots[0];     \
426               memslot < slots->memslots + KVM_MEM_SLOTS_NUM && memslot->npages;\
427                 memslot++)
428
429 int kvm_vcpu_init(struct kvm_vcpu *vcpu, struct kvm *kvm, unsigned id);
430 void kvm_vcpu_uninit(struct kvm_vcpu *vcpu);
431
432 int __must_check vcpu_load(struct kvm_vcpu *vcpu);
433 void vcpu_put(struct kvm_vcpu *vcpu);
434
435 #ifdef CONFIG_HAVE_KVM_IRQ_ROUTING
436 int kvm_irqfd_init(void);
437 void kvm_irqfd_exit(void);
438 #else
439 static inline int kvm_irqfd_init(void)
440 {
441         return 0;
442 }
443
444 static inline void kvm_irqfd_exit(void)
445 {
446 }
447 #endif
448 int kvm_init(void *opaque, unsigned vcpu_size, unsigned vcpu_align,
449                   struct module *module);
450 void kvm_exit(void);
451
452 void kvm_get_kvm(struct kvm *kvm);
453 void kvm_put_kvm(struct kvm *kvm);
454 void update_memslots(struct kvm_memslots *slots, struct kvm_memory_slot *new,
455                      u64 last_generation);
456
457 static inline struct kvm_memslots *kvm_memslots(struct kvm *kvm)
458 {
459         return rcu_dereference_check(kvm->memslots,
460                         srcu_read_lock_held(&kvm->srcu)
461                         || lockdep_is_held(&kvm->slots_lock));
462 }
463
464 static inline struct kvm_memory_slot *
465 id_to_memslot(struct kvm_memslots *slots, int id)
466 {
467         int index = slots->id_to_index[id];
468         struct kvm_memory_slot *slot;
469
470         slot = &slots->memslots[index];
471
472         WARN_ON(slot->id != id);
473         return slot;
474 }
475
476 /*
477  * KVM_SET_USER_MEMORY_REGION ioctl allows the following operations:
478  * - create a new memory slot
479  * - delete an existing memory slot
480  * - modify an existing memory slot
481  *   -- move it in the guest physical memory space
482  *   -- just change its flags
483  *
484  * Since flags can be changed by some of these operations, the following
485  * differentiation is the best we can do for __kvm_set_memory_region():
486  */
487 enum kvm_mr_change {
488         KVM_MR_CREATE,
489         KVM_MR_DELETE,
490         KVM_MR_MOVE,
491         KVM_MR_FLAGS_ONLY,
492 };
493
494 int kvm_set_memory_region(struct kvm *kvm,
495                           struct kvm_userspace_memory_region *mem);
496 int __kvm_set_memory_region(struct kvm *kvm,
497                             struct kvm_userspace_memory_region *mem);
498 void kvm_arch_free_memslot(struct kvm_memory_slot *free,
499                            struct kvm_memory_slot *dont);
500 int kvm_arch_create_memslot(struct kvm_memory_slot *slot, unsigned long npages);
501 int kvm_arch_prepare_memory_region(struct kvm *kvm,
502                                 struct kvm_memory_slot *memslot,
503                                 struct kvm_userspace_memory_region *mem,
504                                 enum kvm_mr_change change);
505 void kvm_arch_commit_memory_region(struct kvm *kvm,
506                                 struct kvm_userspace_memory_region *mem,
507                                 const struct kvm_memory_slot *old,
508                                 enum kvm_mr_change change);
509 bool kvm_largepages_enabled(void);
510 void kvm_disable_largepages(void);
511 /* flush all memory translations */
512 void kvm_arch_flush_shadow_all(struct kvm *kvm);
513 /* flush memory translations pointing to 'slot' */
514 void kvm_arch_flush_shadow_memslot(struct kvm *kvm,
515                                    struct kvm_memory_slot *slot);
516
517 int gfn_to_page_many_atomic(struct kvm *kvm, gfn_t gfn, struct page **pages,
518                             int nr_pages);
519
520 struct page *gfn_to_page(struct kvm *kvm, gfn_t gfn);
521 unsigned long gfn_to_hva(struct kvm *kvm, gfn_t gfn);
522 unsigned long gfn_to_hva_memslot(struct kvm_memory_slot *slot, gfn_t gfn);
523 void kvm_release_page_clean(struct page *page);
524 void kvm_release_page_dirty(struct page *page);
525 void kvm_set_page_dirty(struct page *page);
526 void kvm_set_page_accessed(struct page *page);
527
528 pfn_t gfn_to_pfn_atomic(struct kvm *kvm, gfn_t gfn);
529 pfn_t gfn_to_pfn_async(struct kvm *kvm, gfn_t gfn, bool *async,
530                        bool write_fault, bool *writable);
531 pfn_t gfn_to_pfn(struct kvm *kvm, gfn_t gfn);
532 pfn_t gfn_to_pfn_prot(struct kvm *kvm, gfn_t gfn, bool write_fault,
533                       bool *writable);
534 pfn_t gfn_to_pfn_memslot(struct kvm_memory_slot *slot, gfn_t gfn);
535 pfn_t gfn_to_pfn_memslot_atomic(struct kvm_memory_slot *slot, gfn_t gfn);
536
537 void kvm_release_pfn_dirty(pfn_t pfn);
538 void kvm_release_pfn_clean(pfn_t pfn);
539 void kvm_set_pfn_dirty(pfn_t pfn);
540 void kvm_set_pfn_accessed(pfn_t pfn);
541 void kvm_get_pfn(pfn_t pfn);
542
543 int kvm_read_guest_page(struct kvm *kvm, gfn_t gfn, void *data, int offset,
544                         int len);
545 int kvm_read_guest_atomic(struct kvm *kvm, gpa_t gpa, void *data,
546                           unsigned long len);
547 int kvm_read_guest(struct kvm *kvm, gpa_t gpa, void *data, unsigned long len);
548 int kvm_read_guest_cached(struct kvm *kvm, struct gfn_to_hva_cache *ghc,
549                            void *data, unsigned long len);
550 int kvm_write_guest_page(struct kvm *kvm, gfn_t gfn, const void *data,
551                          int offset, int len);
552 int kvm_write_guest(struct kvm *kvm, gpa_t gpa, const void *data,
553                     unsigned long len);
554 int kvm_write_guest_cached(struct kvm *kvm, struct gfn_to_hva_cache *ghc,
555                            void *data, unsigned long len);
556 int kvm_gfn_to_hva_cache_init(struct kvm *kvm, struct gfn_to_hva_cache *ghc,
557                               gpa_t gpa);
558 int kvm_clear_guest_page(struct kvm *kvm, gfn_t gfn, int offset, int len);
559 int kvm_clear_guest(struct kvm *kvm, gpa_t gpa, unsigned long len);
560 struct kvm_memory_slot *gfn_to_memslot(struct kvm *kvm, gfn_t gfn);
561 int kvm_is_visible_gfn(struct kvm *kvm, gfn_t gfn);
562 unsigned long kvm_host_page_size(struct kvm *kvm, gfn_t gfn);
563 void mark_page_dirty(struct kvm *kvm, gfn_t gfn);
564 void mark_page_dirty_in_slot(struct kvm *kvm, struct kvm_memory_slot *memslot,
565                              gfn_t gfn);
566
567 void kvm_vcpu_block(struct kvm_vcpu *vcpu);
568 void kvm_vcpu_kick(struct kvm_vcpu *vcpu);
569 bool kvm_vcpu_yield_to(struct kvm_vcpu *target);
570 void kvm_vcpu_on_spin(struct kvm_vcpu *vcpu);
571 void kvm_resched(struct kvm_vcpu *vcpu);
572 void kvm_load_guest_fpu(struct kvm_vcpu *vcpu);
573 void kvm_put_guest_fpu(struct kvm_vcpu *vcpu);
574
575 void kvm_flush_remote_tlbs(struct kvm *kvm);
576 void kvm_reload_remote_mmus(struct kvm *kvm);
577 void kvm_make_mclock_inprogress_request(struct kvm *kvm);
578 void kvm_make_scan_ioapic_request(struct kvm *kvm);
579
580 long kvm_arch_dev_ioctl(struct file *filp,
581                         unsigned int ioctl, unsigned long arg);
582 long kvm_arch_vcpu_ioctl(struct file *filp,
583                          unsigned int ioctl, unsigned long arg);
584 int kvm_arch_vcpu_fault(struct kvm_vcpu *vcpu, struct vm_fault *vmf);
585
586 int kvm_dev_ioctl_check_extension(long ext);
587
588 int kvm_get_dirty_log(struct kvm *kvm,
589                         struct kvm_dirty_log *log, int *is_dirty);
590 int kvm_vm_ioctl_get_dirty_log(struct kvm *kvm,
591                                 struct kvm_dirty_log *log);
592
593 int kvm_vm_ioctl_set_memory_region(struct kvm *kvm,
594                                    struct kvm_userspace_memory_region *mem);
595 int kvm_vm_ioctl_irq_line(struct kvm *kvm, struct kvm_irq_level *irq_level,
596                         bool line_status);
597 long kvm_arch_vm_ioctl(struct file *filp,
598                        unsigned int ioctl, unsigned long arg);
599
600 int kvm_arch_vcpu_ioctl_get_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
601 int kvm_arch_vcpu_ioctl_set_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
602
603 int kvm_arch_vcpu_ioctl_translate(struct kvm_vcpu *vcpu,
604                                     struct kvm_translation *tr);
605
606 int kvm_arch_vcpu_ioctl_get_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
607 int kvm_arch_vcpu_ioctl_set_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
608 int kvm_arch_vcpu_ioctl_get_sregs(struct kvm_vcpu *vcpu,
609                                   struct kvm_sregs *sregs);
610 int kvm_arch_vcpu_ioctl_set_sregs(struct kvm_vcpu *vcpu,
611                                   struct kvm_sregs *sregs);
612 int kvm_arch_vcpu_ioctl_get_mpstate(struct kvm_vcpu *vcpu,
613                                     struct kvm_mp_state *mp_state);
614 int kvm_arch_vcpu_ioctl_set_mpstate(struct kvm_vcpu *vcpu,
615                                     struct kvm_mp_state *mp_state);
616 int kvm_arch_vcpu_ioctl_set_guest_debug(struct kvm_vcpu *vcpu,
617                                         struct kvm_guest_debug *dbg);
618 int kvm_arch_vcpu_ioctl_run(struct kvm_vcpu *vcpu, struct kvm_run *kvm_run);
619
620 int kvm_arch_init(void *opaque);
621 void kvm_arch_exit(void);
622
623 int kvm_arch_vcpu_init(struct kvm_vcpu *vcpu);
624 void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu);
625
626 void kvm_arch_vcpu_free(struct kvm_vcpu *vcpu);
627 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
628 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
629 struct kvm_vcpu *kvm_arch_vcpu_create(struct kvm *kvm, unsigned int id);
630 int kvm_arch_vcpu_setup(struct kvm_vcpu *vcpu);
631 int kvm_arch_vcpu_postcreate(struct kvm_vcpu *vcpu);
632 void kvm_arch_vcpu_destroy(struct kvm_vcpu *vcpu);
633
634 int kvm_arch_hardware_enable(void *garbage);
635 void kvm_arch_hardware_disable(void *garbage);
636 int kvm_arch_hardware_setup(void);
637 void kvm_arch_hardware_unsetup(void);
638 void kvm_arch_check_processor_compat(void *rtn);
639 int kvm_arch_vcpu_runnable(struct kvm_vcpu *vcpu);
640 int kvm_arch_vcpu_should_kick(struct kvm_vcpu *vcpu);
641
642 void kvm_free_physmem(struct kvm *kvm);
643
644 void *kvm_kvzalloc(unsigned long size);
645 void kvm_kvfree(const void *addr);
646
647 #ifndef __KVM_HAVE_ARCH_VM_ALLOC
648 static inline struct kvm *kvm_arch_alloc_vm(void)
649 {
650         return kzalloc(sizeof(struct kvm), GFP_KERNEL);
651 }
652
653 static inline void kvm_arch_free_vm(struct kvm *kvm)
654 {
655         kfree(kvm);
656 }
657 #endif
658
659 static inline wait_queue_head_t *kvm_arch_vcpu_wq(struct kvm_vcpu *vcpu)
660 {
661 #ifdef __KVM_HAVE_ARCH_WQP
662         return vcpu->arch.wqp;
663 #else
664         return &vcpu->wq;
665 #endif
666 }
667
668 int kvm_arch_init_vm(struct kvm *kvm, unsigned long type);
669 void kvm_arch_destroy_vm(struct kvm *kvm);
670 void kvm_free_all_assigned_devices(struct kvm *kvm);
671 void kvm_arch_sync_events(struct kvm *kvm);
672
673 int kvm_cpu_has_pending_timer(struct kvm_vcpu *vcpu);
674 void kvm_vcpu_kick(struct kvm_vcpu *vcpu);
675
676 bool kvm_is_mmio_pfn(pfn_t pfn);
677
678 struct kvm_irq_ack_notifier {
679         struct hlist_node link;
680         unsigned gsi;
681         void (*irq_acked)(struct kvm_irq_ack_notifier *kian);
682 };
683
684 struct kvm_assigned_dev_kernel {
685         struct kvm_irq_ack_notifier ack_notifier;
686         struct list_head list;
687         int assigned_dev_id;
688         int host_segnr;
689         int host_busnr;
690         int host_devfn;
691         unsigned int entries_nr;
692         int host_irq;
693         bool host_irq_disabled;
694         bool pci_2_3;
695         struct msix_entry *host_msix_entries;
696         int guest_irq;
697         struct msix_entry *guest_msix_entries;
698         unsigned long irq_requested_type;
699         int irq_source_id;
700         int flags;
701         struct pci_dev *dev;
702         struct kvm *kvm;
703         spinlock_t intx_lock;
704         spinlock_t intx_mask_lock;
705         char irq_name[32];
706         struct pci_saved_state *pci_saved_state;
707 };
708
709 struct kvm_irq_mask_notifier {
710         void (*func)(struct kvm_irq_mask_notifier *kimn, bool masked);
711         int irq;
712         struct hlist_node link;
713 };
714
715 void kvm_register_irq_mask_notifier(struct kvm *kvm, int irq,
716                                     struct kvm_irq_mask_notifier *kimn);
717 void kvm_unregister_irq_mask_notifier(struct kvm *kvm, int irq,
718                                       struct kvm_irq_mask_notifier *kimn);
719 void kvm_fire_mask_notifiers(struct kvm *kvm, unsigned irqchip, unsigned pin,
720                              bool mask);
721
722 int kvm_set_irq(struct kvm *kvm, int irq_source_id, u32 irq, int level,
723                 bool line_status);
724 int kvm_set_irq_inatomic(struct kvm *kvm, int irq_source_id, u32 irq, int level);
725 int kvm_set_msi(struct kvm_kernel_irq_routing_entry *irq_entry, struct kvm *kvm,
726                 int irq_source_id, int level, bool line_status);
727 bool kvm_irq_has_notifier(struct kvm *kvm, unsigned irqchip, unsigned pin);
728 void kvm_notify_acked_irq(struct kvm *kvm, unsigned irqchip, unsigned pin);
729 void kvm_register_irq_ack_notifier(struct kvm *kvm,
730                                    struct kvm_irq_ack_notifier *kian);
731 void kvm_unregister_irq_ack_notifier(struct kvm *kvm,
732                                    struct kvm_irq_ack_notifier *kian);
733 int kvm_request_irq_source_id(struct kvm *kvm);
734 void kvm_free_irq_source_id(struct kvm *kvm, int irq_source_id);
735
736 /* For vcpu->arch.iommu_flags */
737 #define KVM_IOMMU_CACHE_COHERENCY       0x1
738
739 #ifdef CONFIG_IOMMU_API
740 int kvm_iommu_map_pages(struct kvm *kvm, struct kvm_memory_slot *slot);
741 void kvm_iommu_unmap_pages(struct kvm *kvm, struct kvm_memory_slot *slot);
742 int kvm_iommu_map_guest(struct kvm *kvm);
743 int kvm_iommu_unmap_guest(struct kvm *kvm);
744 int kvm_assign_device(struct kvm *kvm,
745                       struct kvm_assigned_dev_kernel *assigned_dev);
746 int kvm_deassign_device(struct kvm *kvm,
747                         struct kvm_assigned_dev_kernel *assigned_dev);
748 #else /* CONFIG_IOMMU_API */
749 static inline int kvm_iommu_map_pages(struct kvm *kvm,
750                                       struct kvm_memory_slot *slot)
751 {
752         return 0;
753 }
754
755 static inline void kvm_iommu_unmap_pages(struct kvm *kvm,
756                                          struct kvm_memory_slot *slot)
757 {
758 }
759
760 static inline int kvm_iommu_map_guest(struct kvm *kvm)
761 {
762         return -ENODEV;
763 }
764
765 static inline int kvm_iommu_unmap_guest(struct kvm *kvm)
766 {
767         return 0;
768 }
769
770 static inline int kvm_assign_device(struct kvm *kvm,
771                 struct kvm_assigned_dev_kernel *assigned_dev)
772 {
773         return 0;
774 }
775
776 static inline int kvm_deassign_device(struct kvm *kvm,
777                 struct kvm_assigned_dev_kernel *assigned_dev)
778 {
779         return 0;
780 }
781 #endif /* CONFIG_IOMMU_API */
782
783 static inline void __guest_enter(void)
784 {
785         /*
786          * This is running in ioctl context so we can avoid
787          * the call to vtime_account() with its unnecessary idle check.
788          */
789         vtime_account_system(current);
790         current->flags |= PF_VCPU;
791 }
792
793 static inline void __guest_exit(void)
794 {
795         /*
796          * This is running in ioctl context so we can avoid
797          * the call to vtime_account() with its unnecessary idle check.
798          */
799         vtime_account_system(current);
800         current->flags &= ~PF_VCPU;
801 }
802
803 #ifdef CONFIG_CONTEXT_TRACKING
804 extern void guest_enter(void);
805 extern void guest_exit(void);
806
807 #else /* !CONFIG_CONTEXT_TRACKING */
808 static inline void guest_enter(void)
809 {
810         __guest_enter();
811 }
812
813 static inline void guest_exit(void)
814 {
815         __guest_exit();
816 }
817 #endif /* !CONFIG_CONTEXT_TRACKING */
818
819 static inline void kvm_guest_enter(void)
820 {
821         unsigned long flags;
822
823         BUG_ON(preemptible());
824
825         local_irq_save(flags);
826         guest_enter();
827         local_irq_restore(flags);
828
829         /* KVM does not hold any references to rcu protected data when it
830          * switches CPU into a guest mode. In fact switching to a guest mode
831          * is very similar to exiting to userspase from rcu point of view. In
832          * addition CPU may stay in a guest mode for quite a long time (up to
833          * one time slice). Lets treat guest mode as quiescent state, just like
834          * we do with user-mode execution.
835          */
836         rcu_virt_note_context_switch(smp_processor_id());
837 }
838
839 static inline void kvm_guest_exit(void)
840 {
841         unsigned long flags;
842
843         local_irq_save(flags);
844         guest_exit();
845         local_irq_restore(flags);
846 }
847
848 /*
849  * search_memslots() and __gfn_to_memslot() are here because they are
850  * used in non-modular code in arch/powerpc/kvm/book3s_hv_rm_mmu.c.
851  * gfn_to_memslot() itself isn't here as an inline because that would
852  * bloat other code too much.
853  */
854 static inline struct kvm_memory_slot *
855 search_memslots(struct kvm_memslots *slots, gfn_t gfn)
856 {
857         struct kvm_memory_slot *memslot;
858
859         kvm_for_each_memslot(memslot, slots)
860                 if (gfn >= memslot->base_gfn &&
861                       gfn < memslot->base_gfn + memslot->npages)
862                         return memslot;
863
864         return NULL;
865 }
866
867 static inline struct kvm_memory_slot *
868 __gfn_to_memslot(struct kvm_memslots *slots, gfn_t gfn)
869 {
870         return search_memslots(slots, gfn);
871 }
872
873 static inline unsigned long
874 __gfn_to_hva_memslot(struct kvm_memory_slot *slot, gfn_t gfn)
875 {
876         return slot->userspace_addr + (gfn - slot->base_gfn) * PAGE_SIZE;
877 }
878
879 static inline int memslot_id(struct kvm *kvm, gfn_t gfn)
880 {
881         return gfn_to_memslot(kvm, gfn)->id;
882 }
883
884 static inline gfn_t gfn_to_index(gfn_t gfn, gfn_t base_gfn, int level)
885 {
886         /* KVM_HPAGE_GFN_SHIFT(PT_PAGE_TABLE_LEVEL) must be 0. */
887         return (gfn >> KVM_HPAGE_GFN_SHIFT(level)) -
888                 (base_gfn >> KVM_HPAGE_GFN_SHIFT(level));
889 }
890
891 static inline gfn_t
892 hva_to_gfn_memslot(unsigned long hva, struct kvm_memory_slot *slot)
893 {
894         gfn_t gfn_offset = (hva - slot->userspace_addr) >> PAGE_SHIFT;
895
896         return slot->base_gfn + gfn_offset;
897 }
898
899 static inline gpa_t gfn_to_gpa(gfn_t gfn)
900 {
901         return (gpa_t)gfn << PAGE_SHIFT;
902 }
903
904 static inline gfn_t gpa_to_gfn(gpa_t gpa)
905 {
906         return (gfn_t)(gpa >> PAGE_SHIFT);
907 }
908
909 static inline hpa_t pfn_to_hpa(pfn_t pfn)
910 {
911         return (hpa_t)pfn << PAGE_SHIFT;
912 }
913
914 static inline void kvm_migrate_timers(struct kvm_vcpu *vcpu)
915 {
916         set_bit(KVM_REQ_MIGRATE_TIMER, &vcpu->requests);
917 }
918
919 enum kvm_stat_kind {
920         KVM_STAT_VM,
921         KVM_STAT_VCPU,
922 };
923
924 struct kvm_stats_debugfs_item {
925         const char *name;
926         int offset;
927         enum kvm_stat_kind kind;
928         struct dentry *dentry;
929 };
930 extern struct kvm_stats_debugfs_item debugfs_entries[];
931 extern struct dentry *kvm_debugfs_dir;
932
933 #if defined(CONFIG_MMU_NOTIFIER) && defined(KVM_ARCH_WANT_MMU_NOTIFIER)
934 static inline int mmu_notifier_retry(struct kvm *kvm, unsigned long mmu_seq)
935 {
936         if (unlikely(kvm->mmu_notifier_count))
937                 return 1;
938         /*
939          * Ensure the read of mmu_notifier_count happens before the read
940          * of mmu_notifier_seq.  This interacts with the smp_wmb() in
941          * mmu_notifier_invalidate_range_end to make sure that the caller
942          * either sees the old (non-zero) value of mmu_notifier_count or
943          * the new (incremented) value of mmu_notifier_seq.
944          * PowerPC Book3s HV KVM calls this under a per-page lock
945          * rather than under kvm->mmu_lock, for scalability, so
946          * can't rely on kvm->mmu_lock to keep things ordered.
947          */
948         smp_rmb();
949         if (kvm->mmu_notifier_seq != mmu_seq)
950                 return 1;
951         return 0;
952 }
953 #endif
954
955 #ifdef CONFIG_HAVE_KVM_IRQ_ROUTING
956
957 #define KVM_MAX_IRQ_ROUTES 1024
958
959 int kvm_setup_default_irq_routing(struct kvm *kvm);
960 int kvm_set_irq_routing(struct kvm *kvm,
961                         const struct kvm_irq_routing_entry *entries,
962                         unsigned nr,
963                         unsigned flags);
964 int kvm_set_routing_entry(struct kvm_irq_routing_table *rt,
965                           struct kvm_kernel_irq_routing_entry *e,
966                           const struct kvm_irq_routing_entry *ue);
967 void kvm_free_irq_routing(struct kvm *kvm);
968
969 int kvm_send_userspace_msi(struct kvm *kvm, struct kvm_msi *msi);
970
971 #else
972
973 static inline void kvm_free_irq_routing(struct kvm *kvm) {}
974
975 #endif
976
977 #ifdef CONFIG_HAVE_KVM_EVENTFD
978
979 void kvm_eventfd_init(struct kvm *kvm);
980 int kvm_ioeventfd(struct kvm *kvm, struct kvm_ioeventfd *args);
981
982 #ifdef CONFIG_HAVE_KVM_IRQCHIP
983 int kvm_irqfd(struct kvm *kvm, struct kvm_irqfd *args);
984 void kvm_irqfd_release(struct kvm *kvm);
985 void kvm_irq_routing_update(struct kvm *, struct kvm_irq_routing_table *);
986 #else
987 static inline int kvm_irqfd(struct kvm *kvm, struct kvm_irqfd *args)
988 {
989         return -EINVAL;
990 }
991
992 static inline void kvm_irqfd_release(struct kvm *kvm) {}
993 #endif
994
995 #else
996
997 static inline void kvm_eventfd_init(struct kvm *kvm) {}
998
999 static inline int kvm_irqfd(struct kvm *kvm, struct kvm_irqfd *args)
1000 {
1001         return -EINVAL;
1002 }
1003
1004 static inline void kvm_irqfd_release(struct kvm *kvm) {}
1005
1006 #ifdef CONFIG_HAVE_KVM_IRQCHIP
1007 static inline void kvm_irq_routing_update(struct kvm *kvm,
1008                                           struct kvm_irq_routing_table *irq_rt)
1009 {
1010         rcu_assign_pointer(kvm->irq_routing, irq_rt);
1011 }
1012 #endif
1013
1014 static inline int kvm_ioeventfd(struct kvm *kvm, struct kvm_ioeventfd *args)
1015 {
1016         return -ENOSYS;
1017 }
1018
1019 #endif /* CONFIG_HAVE_KVM_EVENTFD */
1020
1021 #ifdef CONFIG_KVM_APIC_ARCHITECTURE
1022 static inline bool kvm_vcpu_is_bsp(struct kvm_vcpu *vcpu)
1023 {
1024         return vcpu->kvm->bsp_vcpu_id == vcpu->vcpu_id;
1025 }
1026
1027 bool kvm_vcpu_compatible(struct kvm_vcpu *vcpu);
1028
1029 #else
1030
1031 static inline bool kvm_vcpu_compatible(struct kvm_vcpu *vcpu) { return true; }
1032
1033 #endif
1034
1035 #ifdef __KVM_HAVE_DEVICE_ASSIGNMENT
1036
1037 long kvm_vm_ioctl_assigned_device(struct kvm *kvm, unsigned ioctl,
1038                                   unsigned long arg);
1039
1040 #else
1041
1042 static inline long kvm_vm_ioctl_assigned_device(struct kvm *kvm, unsigned ioctl,
1043                                                 unsigned long arg)
1044 {
1045         return -ENOTTY;
1046 }
1047
1048 #endif
1049
1050 static inline void kvm_make_request(int req, struct kvm_vcpu *vcpu)
1051 {
1052         set_bit(req, &vcpu->requests);
1053 }
1054
1055 static inline bool kvm_check_request(int req, struct kvm_vcpu *vcpu)
1056 {
1057         if (test_bit(req, &vcpu->requests)) {
1058                 clear_bit(req, &vcpu->requests);
1059                 return true;
1060         } else {
1061                 return false;
1062         }
1063 }
1064
1065 extern bool kvm_rebooting;
1066
1067 struct kvm_device_ops;
1068
1069 struct kvm_device {
1070         struct kvm_device_ops *ops;
1071         struct kvm *kvm;
1072         atomic_t users;
1073         void *private;
1074 };
1075
1076 /* create, destroy, and name are mandatory */
1077 struct kvm_device_ops {
1078         const char *name;
1079         int (*create)(struct kvm_device *dev, u32 type);
1080
1081         /*
1082          * Destroy is responsible for freeing dev.
1083          *
1084          * Destroy may be called before or after destructors are called
1085          * on emulated I/O regions, depending on whether a reference is
1086          * held by a vcpu or other kvm component that gets destroyed
1087          * after the emulated I/O.
1088          */
1089         void (*destroy)(struct kvm_device *dev);
1090
1091         int (*set_attr)(struct kvm_device *dev, struct kvm_device_attr *attr);
1092         int (*get_attr)(struct kvm_device *dev, struct kvm_device_attr *attr);
1093         int (*has_attr)(struct kvm_device *dev, struct kvm_device_attr *attr);
1094         long (*ioctl)(struct kvm_device *dev, unsigned int ioctl,
1095                       unsigned long arg);
1096 };
1097
1098 void kvm_device_get(struct kvm_device *dev);
1099 void kvm_device_put(struct kvm_device *dev);
1100 struct kvm_device *kvm_device_from_filp(struct file *filp);
1101
1102 extern struct kvm_device_ops kvm_mpic_ops;
1103
1104 #ifdef CONFIG_HAVE_KVM_CPU_RELAX_INTERCEPT
1105
1106 static inline void kvm_vcpu_set_in_spin_loop(struct kvm_vcpu *vcpu, bool val)
1107 {
1108         vcpu->spin_loop.in_spin_loop = val;
1109 }
1110 static inline void kvm_vcpu_set_dy_eligible(struct kvm_vcpu *vcpu, bool val)
1111 {
1112         vcpu->spin_loop.dy_eligible = val;
1113 }
1114
1115 #else /* !CONFIG_HAVE_KVM_CPU_RELAX_INTERCEPT */
1116
1117 static inline void kvm_vcpu_set_in_spin_loop(struct kvm_vcpu *vcpu, bool val)
1118 {
1119 }
1120
1121 static inline void kvm_vcpu_set_dy_eligible(struct kvm_vcpu *vcpu, bool val)
1122 {
1123 }
1124
1125 static inline bool kvm_vcpu_eligible_for_directed_yield(struct kvm_vcpu *vcpu)
1126 {
1127         return true;
1128 }
1129
1130 #endif /* CONFIG_HAVE_KVM_CPU_RELAX_INTERCEPT */
1131 #else
1132 static inline void __guest_enter(void) { return; }
1133 static inline void __guest_exit(void) { return; }
1134 #endif /* IS_ENABLED(CONFIG_KVM) */
1135 #endif