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