GNU Linux-libre 4.19.209-gnu1
[releases.git] / 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/bug.h>
17 #include <linux/mm.h>
18 #include <linux/mmu_notifier.h>
19 #include <linux/preempt.h>
20 #include <linux/msi.h>
21 #include <linux/slab.h>
22 #include <linux/vmalloc.h>
23 #include <linux/rcupdate.h>
24 #include <linux/ratelimit.h>
25 #include <linux/err.h>
26 #include <linux/irqflags.h>
27 #include <linux/context_tracking.h>
28 #include <linux/irqbypass.h>
29 #include <linux/swait.h>
30 #include <linux/refcount.h>
31 #include <linux/nospec.h>
32 #include <asm/signal.h>
33
34 #include <linux/kvm.h>
35 #include <linux/kvm_para.h>
36
37 #include <linux/kvm_types.h>
38
39 #include <asm/kvm_host.h>
40
41 #ifndef KVM_MAX_VCPU_ID
42 #define KVM_MAX_VCPU_ID KVM_MAX_VCPUS
43 #endif
44
45 /*
46  * The bit 16 ~ bit 31 of kvm_memory_region::flags are internally used
47  * in kvm, other bits are visible for userspace which are defined in
48  * include/linux/kvm_h.
49  */
50 #define KVM_MEMSLOT_INVALID     (1UL << 16)
51
52 /* Two fragments for cross MMIO pages. */
53 #define KVM_MAX_MMIO_FRAGMENTS  2
54
55 #ifndef KVM_ADDRESS_SPACE_NUM
56 #define KVM_ADDRESS_SPACE_NUM   1
57 #endif
58
59 /*
60  * For the normal pfn, the highest 12 bits should be zero,
61  * so we can mask bit 62 ~ bit 52  to indicate the error pfn,
62  * mask bit 63 to indicate the noslot pfn.
63  */
64 #define KVM_PFN_ERR_MASK        (0x7ffULL << 52)
65 #define KVM_PFN_ERR_NOSLOT_MASK (0xfffULL << 52)
66 #define KVM_PFN_NOSLOT          (0x1ULL << 63)
67
68 #define KVM_PFN_ERR_FAULT       (KVM_PFN_ERR_MASK)
69 #define KVM_PFN_ERR_HWPOISON    (KVM_PFN_ERR_MASK + 1)
70 #define KVM_PFN_ERR_RO_FAULT    (KVM_PFN_ERR_MASK + 2)
71
72 /*
73  * error pfns indicate that the gfn is in slot but faild to
74  * translate it to pfn on host.
75  */
76 static inline bool is_error_pfn(kvm_pfn_t pfn)
77 {
78         return !!(pfn & KVM_PFN_ERR_MASK);
79 }
80
81 /*
82  * error_noslot pfns indicate that the gfn can not be
83  * translated to pfn - it is not in slot or failed to
84  * translate it to pfn.
85  */
86 static inline bool is_error_noslot_pfn(kvm_pfn_t pfn)
87 {
88         return !!(pfn & KVM_PFN_ERR_NOSLOT_MASK);
89 }
90
91 /* noslot pfn indicates that the gfn is not in slot. */
92 static inline bool is_noslot_pfn(kvm_pfn_t pfn)
93 {
94         return pfn == KVM_PFN_NOSLOT;
95 }
96
97 /*
98  * architectures with KVM_HVA_ERR_BAD other than PAGE_OFFSET (e.g. s390)
99  * provide own defines and kvm_is_error_hva
100  */
101 #ifndef KVM_HVA_ERR_BAD
102
103 #define KVM_HVA_ERR_BAD         (PAGE_OFFSET)
104 #define KVM_HVA_ERR_RO_BAD      (PAGE_OFFSET + PAGE_SIZE)
105
106 static inline bool kvm_is_error_hva(unsigned long addr)
107 {
108         return addr >= PAGE_OFFSET;
109 }
110
111 #endif
112
113 #define KVM_ERR_PTR_BAD_PAGE    (ERR_PTR(-ENOENT))
114
115 static inline bool is_error_page(struct page *page)
116 {
117         return IS_ERR(page);
118 }
119
120 #define KVM_REQUEST_MASK           GENMASK(7,0)
121 #define KVM_REQUEST_NO_WAKEUP      BIT(8)
122 #define KVM_REQUEST_WAIT           BIT(9)
123 /*
124  * Architecture-independent vcpu->requests bit members
125  * Bits 4-7 are reserved for more arch-independent bits.
126  */
127 #define KVM_REQ_TLB_FLUSH         (0 | KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
128 #define KVM_REQ_MMU_RELOAD        (1 | KVM_REQUEST_WAIT | KVM_REQUEST_NO_WAKEUP)
129 #define KVM_REQ_PENDING_TIMER     2
130 #define KVM_REQ_UNHALT            3
131 #define KVM_REQUEST_ARCH_BASE     8
132
133 #define KVM_ARCH_REQ_FLAGS(nr, flags) ({ \
134         BUILD_BUG_ON((unsigned)(nr) >= (FIELD_SIZEOF(struct kvm_vcpu, requests) * 8) - KVM_REQUEST_ARCH_BASE); \
135         (unsigned)(((nr) + KVM_REQUEST_ARCH_BASE) | (flags)); \
136 })
137 #define KVM_ARCH_REQ(nr)           KVM_ARCH_REQ_FLAGS(nr, 0)
138
139 #define KVM_USERSPACE_IRQ_SOURCE_ID             0
140 #define KVM_IRQFD_RESAMPLE_IRQ_SOURCE_ID        1
141
142 extern struct kmem_cache *kvm_vcpu_cache;
143
144 extern struct mutex kvm_lock;
145 extern struct list_head vm_list;
146
147 struct kvm_io_range {
148         gpa_t addr;
149         int len;
150         struct kvm_io_device *dev;
151 };
152
153 #define NR_IOBUS_DEVS 1000
154
155 struct kvm_io_bus {
156         int dev_count;
157         int ioeventfd_count;
158         struct kvm_io_range range[];
159 };
160
161 enum kvm_bus {
162         KVM_MMIO_BUS,
163         KVM_PIO_BUS,
164         KVM_VIRTIO_CCW_NOTIFY_BUS,
165         KVM_FAST_MMIO_BUS,
166         KVM_NR_BUSES
167 };
168
169 int kvm_io_bus_write(struct kvm_vcpu *vcpu, enum kvm_bus bus_idx, gpa_t addr,
170                      int len, const void *val);
171 int kvm_io_bus_write_cookie(struct kvm_vcpu *vcpu, enum kvm_bus bus_idx,
172                             gpa_t addr, int len, const void *val, long cookie);
173 int kvm_io_bus_read(struct kvm_vcpu *vcpu, enum kvm_bus bus_idx, gpa_t addr,
174                     int len, void *val);
175 int kvm_io_bus_register_dev(struct kvm *kvm, enum kvm_bus bus_idx, gpa_t addr,
176                             int len, struct kvm_io_device *dev);
177 void kvm_io_bus_unregister_dev(struct kvm *kvm, enum kvm_bus bus_idx,
178                                struct kvm_io_device *dev);
179 struct kvm_io_device *kvm_io_bus_get_dev(struct kvm *kvm, enum kvm_bus bus_idx,
180                                          gpa_t addr);
181
182 #ifdef CONFIG_KVM_ASYNC_PF
183 struct kvm_async_pf {
184         struct work_struct work;
185         struct list_head link;
186         struct list_head queue;
187         struct kvm_vcpu *vcpu;
188         struct mm_struct *mm;
189         gpa_t cr2_or_gpa;
190         unsigned long addr;
191         struct kvm_arch_async_pf arch;
192         bool   wakeup_all;
193 };
194
195 void kvm_clear_async_pf_completion_queue(struct kvm_vcpu *vcpu);
196 void kvm_check_async_pf_completion(struct kvm_vcpu *vcpu);
197 int kvm_setup_async_pf(struct kvm_vcpu *vcpu, gpa_t cr2_or_gpa,
198                        unsigned long hva, struct kvm_arch_async_pf *arch);
199 int kvm_async_pf_wakeup_all(struct kvm_vcpu *vcpu);
200 #endif
201
202 enum {
203         OUTSIDE_GUEST_MODE,
204         IN_GUEST_MODE,
205         EXITING_GUEST_MODE,
206         READING_SHADOW_PAGE_TABLES,
207 };
208
209 #define KVM_UNMAPPED_PAGE       ((void *) 0x500 + POISON_POINTER_DELTA)
210
211 struct kvm_host_map {
212         /*
213          * Only valid if the 'pfn' is managed by the host kernel (i.e. There is
214          * a 'struct page' for it. When using mem= kernel parameter some memory
215          * can be used as guest memory but they are not managed by host
216          * kernel).
217          * If 'pfn' is not managed by the host kernel, this field is
218          * initialized to KVM_UNMAPPED_PAGE.
219          */
220         struct page *page;
221         void *hva;
222         kvm_pfn_t pfn;
223         kvm_pfn_t gfn;
224 };
225
226 /*
227  * Used to check if the mapping is valid or not. Never use 'kvm_host_map'
228  * directly to check for that.
229  */
230 static inline bool kvm_vcpu_mapped(struct kvm_host_map *map)
231 {
232         return !!map->hva;
233 }
234
235 /*
236  * Sometimes a large or cross-page mmio needs to be broken up into separate
237  * exits for userspace servicing.
238  */
239 struct kvm_mmio_fragment {
240         gpa_t gpa;
241         void *data;
242         unsigned len;
243 };
244
245 struct kvm_vcpu {
246         struct kvm *kvm;
247 #ifdef CONFIG_PREEMPT_NOTIFIERS
248         struct preempt_notifier preempt_notifier;
249 #endif
250         int cpu;
251         int vcpu_id; /* id given by userspace at creation */
252         int vcpu_idx; /* index in kvm->vcpus array */
253         int srcu_idx;
254         int mode;
255         u64 requests;
256         unsigned long guest_debug;
257
258         int pre_pcpu;
259         struct list_head blocked_vcpu_list;
260
261         struct mutex mutex;
262         struct kvm_run *run;
263
264         int guest_xcr0_loaded;
265         struct swait_queue_head wq;
266         struct pid __rcu *pid;
267         int sigset_active;
268         sigset_t sigset;
269         struct kvm_vcpu_stat stat;
270         unsigned int halt_poll_ns;
271         bool valid_wakeup;
272
273 #ifdef CONFIG_HAS_IOMEM
274         int mmio_needed;
275         int mmio_read_completed;
276         int mmio_is_write;
277         int mmio_cur_fragment;
278         int mmio_nr_fragments;
279         struct kvm_mmio_fragment mmio_fragments[KVM_MAX_MMIO_FRAGMENTS];
280 #endif
281
282 #ifdef CONFIG_KVM_ASYNC_PF
283         struct {
284                 u32 queued;
285                 struct list_head queue;
286                 struct list_head done;
287                 spinlock_t lock;
288         } async_pf;
289 #endif
290
291 #ifdef CONFIG_HAVE_KVM_CPU_RELAX_INTERCEPT
292         /*
293          * Cpu relax intercept or pause loop exit optimization
294          * in_spin_loop: set when a vcpu does a pause loop exit
295          *  or cpu relax intercepted.
296          * dy_eligible: indicates whether vcpu is eligible for directed yield.
297          */
298         struct {
299                 bool in_spin_loop;
300                 bool dy_eligible;
301         } spin_loop;
302 #endif
303         bool preempted;
304         struct kvm_vcpu_arch arch;
305         struct dentry *debugfs_dentry;
306 };
307
308 static inline int kvm_vcpu_exiting_guest_mode(struct kvm_vcpu *vcpu)
309 {
310         /*
311          * The memory barrier ensures a previous write to vcpu->requests cannot
312          * be reordered with the read of vcpu->mode.  It pairs with the general
313          * memory barrier following the write of vcpu->mode in VCPU RUN.
314          */
315         smp_mb__before_atomic();
316         return cmpxchg(&vcpu->mode, IN_GUEST_MODE, EXITING_GUEST_MODE);
317 }
318
319 /*
320  * Some of the bitops functions do not support too long bitmaps.
321  * This number must be determined not to exceed such limits.
322  */
323 #define KVM_MEM_MAX_NR_PAGES ((1UL << 31) - 1)
324
325 struct kvm_memory_slot {
326         gfn_t base_gfn;
327         unsigned long npages;
328         unsigned long *dirty_bitmap;
329         struct kvm_arch_memory_slot arch;
330         unsigned long userspace_addr;
331         u32 flags;
332         short id;
333 };
334
335 static inline unsigned long kvm_dirty_bitmap_bytes(struct kvm_memory_slot *memslot)
336 {
337         return ALIGN(memslot->npages, BITS_PER_LONG) / 8;
338 }
339
340 static inline unsigned long *kvm_second_dirty_bitmap(struct kvm_memory_slot *memslot)
341 {
342         unsigned long len = kvm_dirty_bitmap_bytes(memslot);
343
344         return memslot->dirty_bitmap + len / sizeof(*memslot->dirty_bitmap);
345 }
346
347 struct kvm_s390_adapter_int {
348         u64 ind_addr;
349         u64 summary_addr;
350         u64 ind_offset;
351         u32 summary_offset;
352         u32 adapter_id;
353 };
354
355 struct kvm_hv_sint {
356         u32 vcpu;
357         u32 sint;
358 };
359
360 struct kvm_kernel_irq_routing_entry {
361         u32 gsi;
362         u32 type;
363         int (*set)(struct kvm_kernel_irq_routing_entry *e,
364                    struct kvm *kvm, int irq_source_id, int level,
365                    bool line_status);
366         union {
367                 struct {
368                         unsigned irqchip;
369                         unsigned pin;
370                 } irqchip;
371                 struct {
372                         u32 address_lo;
373                         u32 address_hi;
374                         u32 data;
375                         u32 flags;
376                         u32 devid;
377                 } msi;
378                 struct kvm_s390_adapter_int adapter;
379                 struct kvm_hv_sint hv_sint;
380         };
381         struct hlist_node link;
382 };
383
384 #ifdef CONFIG_HAVE_KVM_IRQ_ROUTING
385 struct kvm_irq_routing_table {
386         int chip[KVM_NR_IRQCHIPS][KVM_IRQCHIP_NUM_PINS];
387         u32 nr_rt_entries;
388         /*
389          * Array indexed by gsi. Each entry contains list of irq chips
390          * the gsi is connected to.
391          */
392         struct hlist_head map[0];
393 };
394 #endif
395
396 #ifndef KVM_PRIVATE_MEM_SLOTS
397 #define KVM_PRIVATE_MEM_SLOTS 0
398 #endif
399
400 #ifndef KVM_MEM_SLOTS_NUM
401 #define KVM_MEM_SLOTS_NUM (KVM_USER_MEM_SLOTS + KVM_PRIVATE_MEM_SLOTS)
402 #endif
403
404 #ifndef __KVM_VCPU_MULTIPLE_ADDRESS_SPACE
405 static inline int kvm_arch_vcpu_memslots_id(struct kvm_vcpu *vcpu)
406 {
407         return 0;
408 }
409 #endif
410
411 /*
412  * Note:
413  * memslots are not sorted by id anymore, please use id_to_memslot()
414  * to get the memslot by its id.
415  */
416 struct kvm_memslots {
417         u64 generation;
418         struct kvm_memory_slot memslots[KVM_MEM_SLOTS_NUM];
419         /* The mapping table from slot id to the index in memslots[]. */
420         short id_to_index[KVM_MEM_SLOTS_NUM];
421         atomic_t lru_slot;
422         int used_slots;
423 };
424
425 struct kvm {
426         spinlock_t mmu_lock;
427         struct mutex slots_lock;
428         struct mm_struct *mm; /* userspace tied to this vm */
429         struct kvm_memslots __rcu *memslots[KVM_ADDRESS_SPACE_NUM];
430         struct kvm_vcpu *vcpus[KVM_MAX_VCPUS];
431
432         /*
433          * created_vcpus is protected by kvm->lock, and is incremented
434          * at the beginning of KVM_CREATE_VCPU.  online_vcpus is only
435          * incremented after storing the kvm_vcpu pointer in vcpus,
436          * and is accessed atomically.
437          */
438         atomic_t online_vcpus;
439         int created_vcpus;
440         int last_boosted_vcpu;
441         struct list_head vm_list;
442         struct mutex lock;
443         struct kvm_io_bus __rcu *buses[KVM_NR_BUSES];
444 #ifdef CONFIG_HAVE_KVM_EVENTFD
445         struct {
446                 spinlock_t        lock;
447                 struct list_head  items;
448                 struct list_head  resampler_list;
449                 struct mutex      resampler_lock;
450         } irqfds;
451         struct list_head ioeventfds;
452 #endif
453         struct kvm_vm_stat stat;
454         struct kvm_arch arch;
455         refcount_t users_count;
456 #ifdef CONFIG_KVM_MMIO
457         struct kvm_coalesced_mmio_ring *coalesced_mmio_ring;
458         spinlock_t ring_lock;
459         struct list_head coalesced_zones;
460 #endif
461
462         struct mutex irq_lock;
463 #ifdef CONFIG_HAVE_KVM_IRQCHIP
464         /*
465          * Update side is protected by irq_lock.
466          */
467         struct kvm_irq_routing_table __rcu *irq_routing;
468 #endif
469 #ifdef CONFIG_HAVE_KVM_IRQFD
470         struct hlist_head irq_ack_notifier_list;
471 #endif
472
473 #if defined(CONFIG_MMU_NOTIFIER) && defined(KVM_ARCH_WANT_MMU_NOTIFIER)
474         struct mmu_notifier mmu_notifier;
475         unsigned long mmu_notifier_seq;
476         long mmu_notifier_count;
477 #endif
478         long tlbs_dirty;
479         struct list_head devices;
480         struct dentry *debugfs_dentry;
481         struct kvm_stat_data **debugfs_stat_data;
482         struct srcu_struct srcu;
483         struct srcu_struct irq_srcu;
484         pid_t userspace_pid;
485 };
486
487 #define kvm_err(fmt, ...) \
488         pr_err("kvm [%i]: " fmt, task_pid_nr(current), ## __VA_ARGS__)
489 #define kvm_info(fmt, ...) \
490         pr_info("kvm [%i]: " fmt, task_pid_nr(current), ## __VA_ARGS__)
491 #define kvm_debug(fmt, ...) \
492         pr_debug("kvm [%i]: " fmt, task_pid_nr(current), ## __VA_ARGS__)
493 #define kvm_debug_ratelimited(fmt, ...) \
494         pr_debug_ratelimited("kvm [%i]: " fmt, task_pid_nr(current), \
495                              ## __VA_ARGS__)
496 #define kvm_pr_unimpl(fmt, ...) \
497         pr_err_ratelimited("kvm [%i]: " fmt, \
498                            task_tgid_nr(current), ## __VA_ARGS__)
499
500 /* The guest did something we don't support. */
501 #define vcpu_unimpl(vcpu, fmt, ...)                                     \
502         kvm_pr_unimpl("vcpu%i, guest rIP: 0x%lx " fmt,                  \
503                         (vcpu)->vcpu_id, kvm_rip_read(vcpu), ## __VA_ARGS__)
504
505 #define vcpu_debug(vcpu, fmt, ...)                                      \
506         kvm_debug("vcpu%i " fmt, (vcpu)->vcpu_id, ## __VA_ARGS__)
507 #define vcpu_debug_ratelimited(vcpu, fmt, ...)                          \
508         kvm_debug_ratelimited("vcpu%i " fmt, (vcpu)->vcpu_id,           \
509                               ## __VA_ARGS__)
510 #define vcpu_err(vcpu, fmt, ...)                                        \
511         kvm_err("vcpu%i " fmt, (vcpu)->vcpu_id, ## __VA_ARGS__)
512
513 static inline struct kvm_io_bus *kvm_get_bus(struct kvm *kvm, enum kvm_bus idx)
514 {
515         return srcu_dereference_check(kvm->buses[idx], &kvm->srcu,
516                                       lockdep_is_held(&kvm->slots_lock) ||
517                                       !refcount_read(&kvm->users_count));
518 }
519
520 static inline struct kvm_vcpu *kvm_get_vcpu(struct kvm *kvm, int i)
521 {
522         int num_vcpus = atomic_read(&kvm->online_vcpus);
523         i = array_index_nospec(i, num_vcpus);
524
525         /* Pairs with smp_wmb() in kvm_vm_ioctl_create_vcpu.  */
526         smp_rmb();
527         return kvm->vcpus[i];
528 }
529
530 #define kvm_for_each_vcpu(idx, vcpup, kvm) \
531         for (idx = 0; \
532              idx < atomic_read(&kvm->online_vcpus) && \
533              (vcpup = kvm_get_vcpu(kvm, idx)) != NULL; \
534              idx++)
535
536 static inline struct kvm_vcpu *kvm_get_vcpu_by_id(struct kvm *kvm, int id)
537 {
538         struct kvm_vcpu *vcpu = NULL;
539         int i;
540
541         if (id < 0)
542                 return NULL;
543         if (id < KVM_MAX_VCPUS)
544                 vcpu = kvm_get_vcpu(kvm, id);
545         if (vcpu && vcpu->vcpu_id == id)
546                 return vcpu;
547         kvm_for_each_vcpu(i, vcpu, kvm)
548                 if (vcpu->vcpu_id == id)
549                         return vcpu;
550         return NULL;
551 }
552
553 static inline int kvm_vcpu_get_idx(struct kvm_vcpu *vcpu)
554 {
555         return vcpu->vcpu_idx;
556 }
557
558 #define kvm_for_each_memslot(memslot, slots)    \
559         for (memslot = &slots->memslots[0];     \
560               memslot < slots->memslots + KVM_MEM_SLOTS_NUM && memslot->npages;\
561                 memslot++)
562
563 int kvm_vcpu_init(struct kvm_vcpu *vcpu, struct kvm *kvm, unsigned id);
564 void kvm_vcpu_uninit(struct kvm_vcpu *vcpu);
565
566 void vcpu_load(struct kvm_vcpu *vcpu);
567 void vcpu_put(struct kvm_vcpu *vcpu);
568
569 #ifdef __KVM_HAVE_IOAPIC
570 void kvm_arch_post_irq_ack_notifier_list_update(struct kvm *kvm);
571 void kvm_arch_post_irq_routing_update(struct kvm *kvm);
572 #else
573 static inline void kvm_arch_post_irq_ack_notifier_list_update(struct kvm *kvm)
574 {
575 }
576 static inline void kvm_arch_post_irq_routing_update(struct kvm *kvm)
577 {
578 }
579 #endif
580
581 #ifdef CONFIG_HAVE_KVM_IRQFD
582 int kvm_irqfd_init(void);
583 void kvm_irqfd_exit(void);
584 #else
585 static inline int kvm_irqfd_init(void)
586 {
587         return 0;
588 }
589
590 static inline void kvm_irqfd_exit(void)
591 {
592 }
593 #endif
594 int kvm_init(void *opaque, unsigned vcpu_size, unsigned vcpu_align,
595                   struct module *module);
596 void kvm_exit(void);
597
598 void kvm_get_kvm(struct kvm *kvm);
599 void kvm_put_kvm(struct kvm *kvm);
600
601 static inline struct kvm_memslots *__kvm_memslots(struct kvm *kvm, int as_id)
602 {
603         as_id = array_index_nospec(as_id, KVM_ADDRESS_SPACE_NUM);
604         return srcu_dereference_check(kvm->memslots[as_id], &kvm->srcu,
605                         lockdep_is_held(&kvm->slots_lock) ||
606                         !refcount_read(&kvm->users_count));
607 }
608
609 static inline struct kvm_memslots *kvm_memslots(struct kvm *kvm)
610 {
611         return __kvm_memslots(kvm, 0);
612 }
613
614 static inline struct kvm_memslots *kvm_vcpu_memslots(struct kvm_vcpu *vcpu)
615 {
616         int as_id = kvm_arch_vcpu_memslots_id(vcpu);
617
618         return __kvm_memslots(vcpu->kvm, as_id);
619 }
620
621 static inline struct kvm_memory_slot *
622 id_to_memslot(struct kvm_memslots *slots, int id)
623 {
624         int index = slots->id_to_index[id];
625         struct kvm_memory_slot *slot;
626
627         slot = &slots->memslots[index];
628
629         WARN_ON(slot->id != id);
630         return slot;
631 }
632
633 /*
634  * KVM_SET_USER_MEMORY_REGION ioctl allows the following operations:
635  * - create a new memory slot
636  * - delete an existing memory slot
637  * - modify an existing memory slot
638  *   -- move it in the guest physical memory space
639  *   -- just change its flags
640  *
641  * Since flags can be changed by some of these operations, the following
642  * differentiation is the best we can do for __kvm_set_memory_region():
643  */
644 enum kvm_mr_change {
645         KVM_MR_CREATE,
646         KVM_MR_DELETE,
647         KVM_MR_MOVE,
648         KVM_MR_FLAGS_ONLY,
649 };
650
651 int kvm_set_memory_region(struct kvm *kvm,
652                           const struct kvm_userspace_memory_region *mem);
653 int __kvm_set_memory_region(struct kvm *kvm,
654                             const struct kvm_userspace_memory_region *mem);
655 void kvm_arch_free_memslot(struct kvm *kvm, struct kvm_memory_slot *free,
656                            struct kvm_memory_slot *dont);
657 int kvm_arch_create_memslot(struct kvm *kvm, struct kvm_memory_slot *slot,
658                             unsigned long npages);
659 void kvm_arch_memslots_updated(struct kvm *kvm, u64 gen);
660 int kvm_arch_prepare_memory_region(struct kvm *kvm,
661                                 struct kvm_memory_slot *memslot,
662                                 const struct kvm_userspace_memory_region *mem,
663                                 enum kvm_mr_change change);
664 void kvm_arch_commit_memory_region(struct kvm *kvm,
665                                 const struct kvm_userspace_memory_region *mem,
666                                 const struct kvm_memory_slot *old,
667                                 const struct kvm_memory_slot *new,
668                                 enum kvm_mr_change change);
669 bool kvm_largepages_enabled(void);
670 void kvm_disable_largepages(void);
671 /* flush all memory translations */
672 void kvm_arch_flush_shadow_all(struct kvm *kvm);
673 /* flush memory translations pointing to 'slot' */
674 void kvm_arch_flush_shadow_memslot(struct kvm *kvm,
675                                    struct kvm_memory_slot *slot);
676
677 int gfn_to_page_many_atomic(struct kvm_memory_slot *slot, gfn_t gfn,
678                             struct page **pages, int nr_pages);
679
680 struct page *gfn_to_page(struct kvm *kvm, gfn_t gfn);
681 unsigned long gfn_to_hva(struct kvm *kvm, gfn_t gfn);
682 unsigned long gfn_to_hva_prot(struct kvm *kvm, gfn_t gfn, bool *writable);
683 unsigned long gfn_to_hva_memslot(struct kvm_memory_slot *slot, gfn_t gfn);
684 unsigned long gfn_to_hva_memslot_prot(struct kvm_memory_slot *slot, gfn_t gfn,
685                                       bool *writable);
686 void kvm_release_page_clean(struct page *page);
687 void kvm_release_page_dirty(struct page *page);
688 void kvm_set_page_accessed(struct page *page);
689
690 kvm_pfn_t gfn_to_pfn_atomic(struct kvm *kvm, gfn_t gfn);
691 kvm_pfn_t gfn_to_pfn(struct kvm *kvm, gfn_t gfn);
692 kvm_pfn_t gfn_to_pfn_prot(struct kvm *kvm, gfn_t gfn, bool write_fault,
693                       bool *writable);
694 kvm_pfn_t gfn_to_pfn_memslot(struct kvm_memory_slot *slot, gfn_t gfn);
695 kvm_pfn_t gfn_to_pfn_memslot_atomic(struct kvm_memory_slot *slot, gfn_t gfn);
696 kvm_pfn_t __gfn_to_pfn_memslot(struct kvm_memory_slot *slot, gfn_t gfn,
697                                bool atomic, bool *async, bool write_fault,
698                                bool *writable);
699
700 void kvm_release_pfn_clean(kvm_pfn_t pfn);
701 void kvm_release_pfn_dirty(kvm_pfn_t pfn);
702 void kvm_set_pfn_dirty(kvm_pfn_t pfn);
703 void kvm_set_pfn_accessed(kvm_pfn_t pfn);
704 void kvm_get_pfn(kvm_pfn_t pfn);
705
706 void kvm_release_pfn(kvm_pfn_t pfn, bool dirty, struct gfn_to_pfn_cache *cache);
707 int kvm_read_guest_page(struct kvm *kvm, gfn_t gfn, void *data, int offset,
708                         int len);
709 int kvm_read_guest_atomic(struct kvm *kvm, gpa_t gpa, void *data,
710                           unsigned long len);
711 int kvm_read_guest(struct kvm *kvm, gpa_t gpa, void *data, unsigned long len);
712 int kvm_read_guest_cached(struct kvm *kvm, struct gfn_to_hva_cache *ghc,
713                            void *data, unsigned long len);
714 int kvm_write_guest_page(struct kvm *kvm, gfn_t gfn, const void *data,
715                          int offset, int len);
716 int kvm_write_guest(struct kvm *kvm, gpa_t gpa, const void *data,
717                     unsigned long len);
718 int kvm_write_guest_cached(struct kvm *kvm, struct gfn_to_hva_cache *ghc,
719                            void *data, unsigned long len);
720 int kvm_write_guest_offset_cached(struct kvm *kvm, struct gfn_to_hva_cache *ghc,
721                                   void *data, unsigned int offset,
722                                   unsigned long len);
723 int kvm_gfn_to_hva_cache_init(struct kvm *kvm, struct gfn_to_hva_cache *ghc,
724                               gpa_t gpa, unsigned long len);
725 int kvm_clear_guest_page(struct kvm *kvm, gfn_t gfn, int offset, int len);
726 int kvm_clear_guest(struct kvm *kvm, gpa_t gpa, unsigned long len);
727 struct kvm_memory_slot *gfn_to_memslot(struct kvm *kvm, gfn_t gfn);
728 bool kvm_is_visible_gfn(struct kvm *kvm, gfn_t gfn);
729 unsigned long kvm_host_page_size(struct kvm_vcpu *vcpu, gfn_t gfn);
730 void mark_page_dirty(struct kvm *kvm, gfn_t gfn);
731
732 struct kvm_memslots *kvm_vcpu_memslots(struct kvm_vcpu *vcpu);
733 struct kvm_memory_slot *kvm_vcpu_gfn_to_memslot(struct kvm_vcpu *vcpu, gfn_t gfn);
734 kvm_pfn_t kvm_vcpu_gfn_to_pfn_atomic(struct kvm_vcpu *vcpu, gfn_t gfn);
735 kvm_pfn_t kvm_vcpu_gfn_to_pfn(struct kvm_vcpu *vcpu, gfn_t gfn);
736 int kvm_vcpu_map(struct kvm_vcpu *vcpu, gpa_t gpa, struct kvm_host_map *map);
737 int kvm_map_gfn(struct kvm_vcpu *vcpu, gfn_t gfn, struct kvm_host_map *map,
738                 struct gfn_to_pfn_cache *cache, bool atomic);
739 struct page *kvm_vcpu_gfn_to_page(struct kvm_vcpu *vcpu, gfn_t gfn);
740 void kvm_vcpu_unmap(struct kvm_vcpu *vcpu, struct kvm_host_map *map, bool dirty);
741 int kvm_unmap_gfn(struct kvm_vcpu *vcpu, struct kvm_host_map *map,
742                   struct gfn_to_pfn_cache *cache, bool dirty, bool atomic);
743 unsigned long kvm_vcpu_gfn_to_hva(struct kvm_vcpu *vcpu, gfn_t gfn);
744 unsigned long kvm_vcpu_gfn_to_hva_prot(struct kvm_vcpu *vcpu, gfn_t gfn, bool *writable);
745 int kvm_vcpu_read_guest_page(struct kvm_vcpu *vcpu, gfn_t gfn, void *data, int offset,
746                              int len);
747 int kvm_vcpu_read_guest_atomic(struct kvm_vcpu *vcpu, gpa_t gpa, void *data,
748                                unsigned long len);
749 int kvm_vcpu_read_guest(struct kvm_vcpu *vcpu, gpa_t gpa, void *data,
750                         unsigned long len);
751 int kvm_vcpu_write_guest_page(struct kvm_vcpu *vcpu, gfn_t gfn, const void *data,
752                               int offset, int len);
753 int kvm_vcpu_write_guest(struct kvm_vcpu *vcpu, gpa_t gpa, const void *data,
754                          unsigned long len);
755 void kvm_vcpu_mark_page_dirty(struct kvm_vcpu *vcpu, gfn_t gfn);
756
757 void kvm_sigset_activate(struct kvm_vcpu *vcpu);
758 void kvm_sigset_deactivate(struct kvm_vcpu *vcpu);
759
760 void kvm_vcpu_block(struct kvm_vcpu *vcpu);
761 void kvm_arch_vcpu_blocking(struct kvm_vcpu *vcpu);
762 void kvm_arch_vcpu_unblocking(struct kvm_vcpu *vcpu);
763 bool kvm_vcpu_wake_up(struct kvm_vcpu *vcpu);
764 void kvm_vcpu_kick(struct kvm_vcpu *vcpu);
765 int kvm_vcpu_yield_to(struct kvm_vcpu *target);
766 void kvm_vcpu_on_spin(struct kvm_vcpu *vcpu, bool usermode_vcpu_not_eligible);
767
768 void kvm_flush_remote_tlbs(struct kvm *kvm);
769 void kvm_reload_remote_mmus(struct kvm *kvm);
770
771 bool kvm_make_vcpus_request_mask(struct kvm *kvm, unsigned int req,
772                                  unsigned long *vcpu_bitmap, cpumask_var_t tmp);
773 bool kvm_make_all_cpus_request(struct kvm *kvm, unsigned int req);
774
775 long kvm_arch_dev_ioctl(struct file *filp,
776                         unsigned int ioctl, unsigned long arg);
777 long kvm_arch_vcpu_ioctl(struct file *filp,
778                          unsigned int ioctl, unsigned long arg);
779 vm_fault_t kvm_arch_vcpu_fault(struct kvm_vcpu *vcpu, struct vm_fault *vmf);
780
781 int kvm_vm_ioctl_check_extension(struct kvm *kvm, long ext);
782
783 int kvm_get_dirty_log(struct kvm *kvm,
784                         struct kvm_dirty_log *log, int *is_dirty);
785
786 int kvm_get_dirty_log_protect(struct kvm *kvm,
787                         struct kvm_dirty_log *log, bool *is_dirty);
788
789 void kvm_arch_mmu_enable_log_dirty_pt_masked(struct kvm *kvm,
790                                         struct kvm_memory_slot *slot,
791                                         gfn_t gfn_offset,
792                                         unsigned long mask);
793
794 int kvm_vm_ioctl_get_dirty_log(struct kvm *kvm,
795                                 struct kvm_dirty_log *log);
796
797 int kvm_vm_ioctl_irq_line(struct kvm *kvm, struct kvm_irq_level *irq_level,
798                         bool line_status);
799 long kvm_arch_vm_ioctl(struct file *filp,
800                        unsigned int ioctl, unsigned long arg);
801
802 int kvm_arch_vcpu_ioctl_get_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
803 int kvm_arch_vcpu_ioctl_set_fpu(struct kvm_vcpu *vcpu, struct kvm_fpu *fpu);
804
805 int kvm_arch_vcpu_ioctl_translate(struct kvm_vcpu *vcpu,
806                                     struct kvm_translation *tr);
807
808 int kvm_arch_vcpu_ioctl_get_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
809 int kvm_arch_vcpu_ioctl_set_regs(struct kvm_vcpu *vcpu, struct kvm_regs *regs);
810 int kvm_arch_vcpu_ioctl_get_sregs(struct kvm_vcpu *vcpu,
811                                   struct kvm_sregs *sregs);
812 int kvm_arch_vcpu_ioctl_set_sregs(struct kvm_vcpu *vcpu,
813                                   struct kvm_sregs *sregs);
814 int kvm_arch_vcpu_ioctl_get_mpstate(struct kvm_vcpu *vcpu,
815                                     struct kvm_mp_state *mp_state);
816 int kvm_arch_vcpu_ioctl_set_mpstate(struct kvm_vcpu *vcpu,
817                                     struct kvm_mp_state *mp_state);
818 int kvm_arch_vcpu_ioctl_set_guest_debug(struct kvm_vcpu *vcpu,
819                                         struct kvm_guest_debug *dbg);
820 int kvm_arch_vcpu_ioctl_run(struct kvm_vcpu *vcpu, struct kvm_run *kvm_run);
821
822 int kvm_arch_init(void *opaque);
823 void kvm_arch_exit(void);
824
825 int kvm_arch_vcpu_init(struct kvm_vcpu *vcpu);
826 void kvm_arch_vcpu_uninit(struct kvm_vcpu *vcpu);
827
828 void kvm_arch_sched_in(struct kvm_vcpu *vcpu, int cpu);
829
830 void kvm_arch_vcpu_free(struct kvm_vcpu *vcpu);
831 void kvm_arch_vcpu_load(struct kvm_vcpu *vcpu, int cpu);
832 void kvm_arch_vcpu_put(struct kvm_vcpu *vcpu);
833 struct kvm_vcpu *kvm_arch_vcpu_create(struct kvm *kvm, unsigned int id);
834 int kvm_arch_vcpu_setup(struct kvm_vcpu *vcpu);
835 void kvm_arch_vcpu_postcreate(struct kvm_vcpu *vcpu);
836 void kvm_arch_vcpu_destroy(struct kvm_vcpu *vcpu);
837
838 bool kvm_arch_has_vcpu_debugfs(void);
839 int kvm_arch_create_vcpu_debugfs(struct kvm_vcpu *vcpu);
840
841 int kvm_arch_hardware_enable(void);
842 void kvm_arch_hardware_disable(void);
843 int kvm_arch_hardware_setup(void);
844 void kvm_arch_hardware_unsetup(void);
845 void kvm_arch_check_processor_compat(void *rtn);
846 int kvm_arch_vcpu_runnable(struct kvm_vcpu *vcpu);
847 bool kvm_arch_vcpu_in_kernel(struct kvm_vcpu *vcpu);
848 int kvm_arch_vcpu_should_kick(struct kvm_vcpu *vcpu);
849 bool kvm_arch_dy_runnable(struct kvm_vcpu *vcpu);
850
851 #ifndef __KVM_HAVE_ARCH_VM_ALLOC
852 /*
853  * All architectures that want to use vzalloc currently also
854  * need their own kvm_arch_alloc_vm implementation.
855  */
856 static inline struct kvm *kvm_arch_alloc_vm(void)
857 {
858         return kzalloc(sizeof(struct kvm), GFP_KERNEL);
859 }
860
861 static inline void kvm_arch_free_vm(struct kvm *kvm)
862 {
863         kfree(kvm);
864 }
865 #endif
866
867 #ifndef __KVM_HAVE_ARCH_FLUSH_REMOTE_TLB
868 static inline int kvm_arch_flush_remote_tlb(struct kvm *kvm)
869 {
870         return -ENOTSUPP;
871 }
872 #endif
873
874 #ifdef __KVM_HAVE_ARCH_NONCOHERENT_DMA
875 void kvm_arch_register_noncoherent_dma(struct kvm *kvm);
876 void kvm_arch_unregister_noncoherent_dma(struct kvm *kvm);
877 bool kvm_arch_has_noncoherent_dma(struct kvm *kvm);
878 #else
879 static inline void kvm_arch_register_noncoherent_dma(struct kvm *kvm)
880 {
881 }
882
883 static inline void kvm_arch_unregister_noncoherent_dma(struct kvm *kvm)
884 {
885 }
886
887 static inline bool kvm_arch_has_noncoherent_dma(struct kvm *kvm)
888 {
889         return false;
890 }
891 #endif
892 #ifdef __KVM_HAVE_ARCH_ASSIGNED_DEVICE
893 void kvm_arch_start_assignment(struct kvm *kvm);
894 void kvm_arch_end_assignment(struct kvm *kvm);
895 bool kvm_arch_has_assigned_device(struct kvm *kvm);
896 #else
897 static inline void kvm_arch_start_assignment(struct kvm *kvm)
898 {
899 }
900
901 static inline void kvm_arch_end_assignment(struct kvm *kvm)
902 {
903 }
904
905 static inline bool kvm_arch_has_assigned_device(struct kvm *kvm)
906 {
907         return false;
908 }
909 #endif
910
911 static inline struct swait_queue_head *kvm_arch_vcpu_wq(struct kvm_vcpu *vcpu)
912 {
913 #ifdef __KVM_HAVE_ARCH_WQP
914         return vcpu->arch.wqp;
915 #else
916         return &vcpu->wq;
917 #endif
918 }
919
920 #ifdef __KVM_HAVE_ARCH_INTC_INITIALIZED
921 /*
922  * returns true if the virtual interrupt controller is initialized and
923  * ready to accept virtual IRQ. On some architectures the virtual interrupt
924  * controller is dynamically instantiated and this is not always true.
925  */
926 bool kvm_arch_intc_initialized(struct kvm *kvm);
927 #else
928 static inline bool kvm_arch_intc_initialized(struct kvm *kvm)
929 {
930         return true;
931 }
932 #endif
933
934 int kvm_arch_init_vm(struct kvm *kvm, unsigned long type);
935 void kvm_arch_destroy_vm(struct kvm *kvm);
936 void kvm_arch_sync_events(struct kvm *kvm);
937
938 int kvm_cpu_has_pending_timer(struct kvm_vcpu *vcpu);
939 void kvm_vcpu_kick(struct kvm_vcpu *vcpu);
940
941 bool kvm_is_reserved_pfn(kvm_pfn_t pfn);
942 bool kvm_is_zone_device_pfn(kvm_pfn_t pfn);
943
944 struct kvm_irq_ack_notifier {
945         struct hlist_node link;
946         unsigned gsi;
947         void (*irq_acked)(struct kvm_irq_ack_notifier *kian);
948 };
949
950 int kvm_irq_map_gsi(struct kvm *kvm,
951                     struct kvm_kernel_irq_routing_entry *entries, int gsi);
952 int kvm_irq_map_chip_pin(struct kvm *kvm, unsigned irqchip, unsigned pin);
953
954 int kvm_set_irq(struct kvm *kvm, int irq_source_id, u32 irq, int level,
955                 bool line_status);
956 int kvm_set_msi(struct kvm_kernel_irq_routing_entry *irq_entry, struct kvm *kvm,
957                 int irq_source_id, int level, bool line_status);
958 int kvm_arch_set_irq_inatomic(struct kvm_kernel_irq_routing_entry *e,
959                                struct kvm *kvm, int irq_source_id,
960                                int level, bool line_status);
961 bool kvm_irq_has_notifier(struct kvm *kvm, unsigned irqchip, unsigned pin);
962 void kvm_notify_acked_gsi(struct kvm *kvm, int gsi);
963 void kvm_notify_acked_irq(struct kvm *kvm, unsigned irqchip, unsigned pin);
964 void kvm_register_irq_ack_notifier(struct kvm *kvm,
965                                    struct kvm_irq_ack_notifier *kian);
966 void kvm_unregister_irq_ack_notifier(struct kvm *kvm,
967                                    struct kvm_irq_ack_notifier *kian);
968 int kvm_request_irq_source_id(struct kvm *kvm);
969 void kvm_free_irq_source_id(struct kvm *kvm, int irq_source_id);
970
971 /*
972  * search_memslots() and __gfn_to_memslot() are here because they are
973  * used in non-modular code in arch/powerpc/kvm/book3s_hv_rm_mmu.c.
974  * gfn_to_memslot() itself isn't here as an inline because that would
975  * bloat other code too much.
976  */
977 static inline struct kvm_memory_slot *
978 search_memslots(struct kvm_memslots *slots, gfn_t gfn)
979 {
980         int start = 0, end = slots->used_slots;
981         int slot = atomic_read(&slots->lru_slot);
982         struct kvm_memory_slot *memslots = slots->memslots;
983
984         if (gfn >= memslots[slot].base_gfn &&
985             gfn < memslots[slot].base_gfn + memslots[slot].npages)
986                 return &memslots[slot];
987
988         while (start < end) {
989                 slot = start + (end - start) / 2;
990
991                 if (gfn >= memslots[slot].base_gfn)
992                         end = slot;
993                 else
994                         start = slot + 1;
995         }
996
997         if (start < slots->used_slots && gfn >= memslots[start].base_gfn &&
998             gfn < memslots[start].base_gfn + memslots[start].npages) {
999                 atomic_set(&slots->lru_slot, start);
1000                 return &memslots[start];
1001         }
1002
1003         return NULL;
1004 }
1005
1006 static inline struct kvm_memory_slot *
1007 __gfn_to_memslot(struct kvm_memslots *slots, gfn_t gfn)
1008 {
1009         return search_memslots(slots, gfn);
1010 }
1011
1012 static inline unsigned long
1013 __gfn_to_hva_memslot(struct kvm_memory_slot *slot, gfn_t gfn)
1014 {
1015         /*
1016          * The index was checked originally in search_memslots.  To avoid
1017          * that a malicious guest builds a Spectre gadget out of e.g. page
1018          * table walks, do not let the processor speculate loads outside
1019          * the guest's registered memslots.
1020          */
1021         unsigned long offset = gfn - slot->base_gfn;
1022         offset = array_index_nospec(offset, slot->npages);
1023         return slot->userspace_addr + offset * PAGE_SIZE;
1024 }
1025
1026 static inline int memslot_id(struct kvm *kvm, gfn_t gfn)
1027 {
1028         return gfn_to_memslot(kvm, gfn)->id;
1029 }
1030
1031 static inline gfn_t
1032 hva_to_gfn_memslot(unsigned long hva, struct kvm_memory_slot *slot)
1033 {
1034         gfn_t gfn_offset = (hva - slot->userspace_addr) >> PAGE_SHIFT;
1035
1036         return slot->base_gfn + gfn_offset;
1037 }
1038
1039 static inline gpa_t gfn_to_gpa(gfn_t gfn)
1040 {
1041         return (gpa_t)gfn << PAGE_SHIFT;
1042 }
1043
1044 static inline gfn_t gpa_to_gfn(gpa_t gpa)
1045 {
1046         return (gfn_t)(gpa >> PAGE_SHIFT);
1047 }
1048
1049 static inline hpa_t pfn_to_hpa(kvm_pfn_t pfn)
1050 {
1051         return (hpa_t)pfn << PAGE_SHIFT;
1052 }
1053
1054 static inline struct page *kvm_vcpu_gpa_to_page(struct kvm_vcpu *vcpu,
1055                                                 gpa_t gpa)
1056 {
1057         return kvm_vcpu_gfn_to_page(vcpu, gpa_to_gfn(gpa));
1058 }
1059
1060 static inline bool kvm_is_error_gpa(struct kvm *kvm, gpa_t gpa)
1061 {
1062         unsigned long hva = gfn_to_hva(kvm, gpa_to_gfn(gpa));
1063
1064         return kvm_is_error_hva(hva);
1065 }
1066
1067 enum kvm_stat_kind {
1068         KVM_STAT_VM,
1069         KVM_STAT_VCPU,
1070 };
1071
1072 struct kvm_stat_data {
1073         int offset;
1074         int mode;
1075         struct kvm *kvm;
1076 };
1077
1078 struct kvm_stats_debugfs_item {
1079         const char *name;
1080         int offset;
1081         enum kvm_stat_kind kind;
1082         int mode;
1083 };
1084 extern struct kvm_stats_debugfs_item debugfs_entries[];
1085 extern struct dentry *kvm_debugfs_dir;
1086
1087 #if defined(CONFIG_MMU_NOTIFIER) && defined(KVM_ARCH_WANT_MMU_NOTIFIER)
1088 static inline int mmu_notifier_retry(struct kvm *kvm, unsigned long mmu_seq)
1089 {
1090         if (unlikely(kvm->mmu_notifier_count))
1091                 return 1;
1092         /*
1093          * Ensure the read of mmu_notifier_count happens before the read
1094          * of mmu_notifier_seq.  This interacts with the smp_wmb() in
1095          * mmu_notifier_invalidate_range_end to make sure that the caller
1096          * either sees the old (non-zero) value of mmu_notifier_count or
1097          * the new (incremented) value of mmu_notifier_seq.
1098          * PowerPC Book3s HV KVM calls this under a per-page lock
1099          * rather than under kvm->mmu_lock, for scalability, so
1100          * can't rely on kvm->mmu_lock to keep things ordered.
1101          */
1102         smp_rmb();
1103         if (kvm->mmu_notifier_seq != mmu_seq)
1104                 return 1;
1105         return 0;
1106 }
1107 #endif
1108
1109 #ifdef CONFIG_HAVE_KVM_IRQ_ROUTING
1110
1111 #define KVM_MAX_IRQ_ROUTES 4096 /* might need extension/rework in the future */
1112
1113 bool kvm_arch_can_set_irq_routing(struct kvm *kvm);
1114 int kvm_set_irq_routing(struct kvm *kvm,
1115                         const struct kvm_irq_routing_entry *entries,
1116                         unsigned nr,
1117                         unsigned flags);
1118 int kvm_set_routing_entry(struct kvm *kvm,
1119                           struct kvm_kernel_irq_routing_entry *e,
1120                           const struct kvm_irq_routing_entry *ue);
1121 void kvm_free_irq_routing(struct kvm *kvm);
1122
1123 #else
1124
1125 static inline void kvm_free_irq_routing(struct kvm *kvm) {}
1126
1127 #endif
1128
1129 int kvm_send_userspace_msi(struct kvm *kvm, struct kvm_msi *msi);
1130
1131 #ifdef CONFIG_HAVE_KVM_EVENTFD
1132
1133 void kvm_eventfd_init(struct kvm *kvm);
1134 int kvm_ioeventfd(struct kvm *kvm, struct kvm_ioeventfd *args);
1135
1136 #ifdef CONFIG_HAVE_KVM_IRQFD
1137 int kvm_irqfd(struct kvm *kvm, struct kvm_irqfd *args);
1138 void kvm_irqfd_release(struct kvm *kvm);
1139 void kvm_irq_routing_update(struct kvm *);
1140 #else
1141 static inline int kvm_irqfd(struct kvm *kvm, struct kvm_irqfd *args)
1142 {
1143         return -EINVAL;
1144 }
1145
1146 static inline void kvm_irqfd_release(struct kvm *kvm) {}
1147 #endif
1148
1149 #else
1150
1151 static inline void kvm_eventfd_init(struct kvm *kvm) {}
1152
1153 static inline int kvm_irqfd(struct kvm *kvm, struct kvm_irqfd *args)
1154 {
1155         return -EINVAL;
1156 }
1157
1158 static inline void kvm_irqfd_release(struct kvm *kvm) {}
1159
1160 #ifdef CONFIG_HAVE_KVM_IRQCHIP
1161 static inline void kvm_irq_routing_update(struct kvm *kvm)
1162 {
1163 }
1164 #endif
1165
1166 static inline int kvm_ioeventfd(struct kvm *kvm, struct kvm_ioeventfd *args)
1167 {
1168         return -ENOSYS;
1169 }
1170
1171 #endif /* CONFIG_HAVE_KVM_EVENTFD */
1172
1173 void kvm_arch_irq_routing_update(struct kvm *kvm);
1174
1175 static inline void kvm_make_request(int req, struct kvm_vcpu *vcpu)
1176 {
1177         /*
1178          * Ensure the rest of the request is published to kvm_check_request's
1179          * caller.  Paired with the smp_mb__after_atomic in kvm_check_request.
1180          */
1181         smp_wmb();
1182         set_bit(req & KVM_REQUEST_MASK, (void *)&vcpu->requests);
1183 }
1184
1185 static inline bool kvm_request_pending(struct kvm_vcpu *vcpu)
1186 {
1187         return READ_ONCE(vcpu->requests);
1188 }
1189
1190 static inline bool kvm_test_request(int req, struct kvm_vcpu *vcpu)
1191 {
1192         return test_bit(req & KVM_REQUEST_MASK, (void *)&vcpu->requests);
1193 }
1194
1195 static inline void kvm_clear_request(int req, struct kvm_vcpu *vcpu)
1196 {
1197         clear_bit(req & KVM_REQUEST_MASK, (void *)&vcpu->requests);
1198 }
1199
1200 static inline bool kvm_check_request(int req, struct kvm_vcpu *vcpu)
1201 {
1202         if (kvm_test_request(req, vcpu)) {
1203                 kvm_clear_request(req, vcpu);
1204
1205                 /*
1206                  * Ensure the rest of the request is visible to kvm_check_request's
1207                  * caller.  Paired with the smp_wmb in kvm_make_request.
1208                  */
1209                 smp_mb__after_atomic();
1210                 return true;
1211         } else {
1212                 return false;
1213         }
1214 }
1215
1216 extern bool kvm_rebooting;
1217
1218 extern unsigned int halt_poll_ns;
1219 extern unsigned int halt_poll_ns_grow;
1220 extern unsigned int halt_poll_ns_shrink;
1221
1222 struct kvm_device {
1223         struct kvm_device_ops *ops;
1224         struct kvm *kvm;
1225         void *private;
1226         struct list_head vm_node;
1227 };
1228
1229 /* create, destroy, and name are mandatory */
1230 struct kvm_device_ops {
1231         const char *name;
1232
1233         /*
1234          * create is called holding kvm->lock and any operations not suitable
1235          * to do while holding the lock should be deferred to init (see
1236          * below).
1237          */
1238         int (*create)(struct kvm_device *dev, u32 type);
1239
1240         /*
1241          * init is called after create if create is successful and is called
1242          * outside of holding kvm->lock.
1243          */
1244         void (*init)(struct kvm_device *dev);
1245
1246         /*
1247          * Destroy is responsible for freeing dev.
1248          *
1249          * Destroy may be called before or after destructors are called
1250          * on emulated I/O regions, depending on whether a reference is
1251          * held by a vcpu or other kvm component that gets destroyed
1252          * after the emulated I/O.
1253          */
1254         void (*destroy)(struct kvm_device *dev);
1255
1256         int (*set_attr)(struct kvm_device *dev, struct kvm_device_attr *attr);
1257         int (*get_attr)(struct kvm_device *dev, struct kvm_device_attr *attr);
1258         int (*has_attr)(struct kvm_device *dev, struct kvm_device_attr *attr);
1259         long (*ioctl)(struct kvm_device *dev, unsigned int ioctl,
1260                       unsigned long arg);
1261 };
1262
1263 void kvm_device_get(struct kvm_device *dev);
1264 void kvm_device_put(struct kvm_device *dev);
1265 struct kvm_device *kvm_device_from_filp(struct file *filp);
1266 int kvm_register_device_ops(struct kvm_device_ops *ops, u32 type);
1267 void kvm_unregister_device_ops(u32 type);
1268
1269 extern struct kvm_device_ops kvm_mpic_ops;
1270 extern struct kvm_device_ops kvm_arm_vgic_v2_ops;
1271 extern struct kvm_device_ops kvm_arm_vgic_v3_ops;
1272
1273 #ifdef CONFIG_HAVE_KVM_CPU_RELAX_INTERCEPT
1274
1275 static inline void kvm_vcpu_set_in_spin_loop(struct kvm_vcpu *vcpu, bool val)
1276 {
1277         vcpu->spin_loop.in_spin_loop = val;
1278 }
1279 static inline void kvm_vcpu_set_dy_eligible(struct kvm_vcpu *vcpu, bool val)
1280 {
1281         vcpu->spin_loop.dy_eligible = val;
1282 }
1283
1284 #else /* !CONFIG_HAVE_KVM_CPU_RELAX_INTERCEPT */
1285
1286 static inline void kvm_vcpu_set_in_spin_loop(struct kvm_vcpu *vcpu, bool val)
1287 {
1288 }
1289
1290 static inline void kvm_vcpu_set_dy_eligible(struct kvm_vcpu *vcpu, bool val)
1291 {
1292 }
1293 #endif /* CONFIG_HAVE_KVM_CPU_RELAX_INTERCEPT */
1294
1295 #ifdef CONFIG_HAVE_KVM_IRQ_BYPASS
1296 bool kvm_arch_has_irq_bypass(void);
1297 int kvm_arch_irq_bypass_add_producer(struct irq_bypass_consumer *,
1298                            struct irq_bypass_producer *);
1299 void kvm_arch_irq_bypass_del_producer(struct irq_bypass_consumer *,
1300                            struct irq_bypass_producer *);
1301 void kvm_arch_irq_bypass_stop(struct irq_bypass_consumer *);
1302 void kvm_arch_irq_bypass_start(struct irq_bypass_consumer *);
1303 int kvm_arch_update_irqfd_routing(struct kvm *kvm, unsigned int host_irq,
1304                                   uint32_t guest_irq, bool set);
1305 #endif /* CONFIG_HAVE_KVM_IRQ_BYPASS */
1306
1307 #ifdef CONFIG_HAVE_KVM_INVALID_WAKEUPS
1308 /* If we wakeup during the poll time, was it a sucessful poll? */
1309 static inline bool vcpu_valid_wakeup(struct kvm_vcpu *vcpu)
1310 {
1311         return vcpu->valid_wakeup;
1312 }
1313
1314 #else
1315 static inline bool vcpu_valid_wakeup(struct kvm_vcpu *vcpu)
1316 {
1317         return true;
1318 }
1319 #endif /* CONFIG_HAVE_KVM_INVALID_WAKEUPS */
1320
1321 #ifdef CONFIG_HAVE_KVM_VCPU_ASYNC_IOCTL
1322 long kvm_arch_vcpu_async_ioctl(struct file *filp,
1323                                unsigned int ioctl, unsigned long arg);
1324 #else
1325 static inline long kvm_arch_vcpu_async_ioctl(struct file *filp,
1326                                              unsigned int ioctl,
1327                                              unsigned long arg)
1328 {
1329         return -ENOIOCTLCMD;
1330 }
1331 #endif /* CONFIG_HAVE_KVM_VCPU_ASYNC_IOCTL */
1332
1333 void kvm_arch_mmu_notifier_invalidate_range(struct kvm *kvm,
1334                                             unsigned long start, unsigned long end);
1335
1336 #ifdef CONFIG_HAVE_KVM_VCPU_RUN_PID_CHANGE
1337 int kvm_arch_vcpu_run_pid_change(struct kvm_vcpu *vcpu);
1338 #else
1339 static inline int kvm_arch_vcpu_run_pid_change(struct kvm_vcpu *vcpu)
1340 {
1341         return 0;
1342 }
1343 #endif /* CONFIG_HAVE_KVM_VCPU_RUN_PID_CHANGE */
1344
1345 typedef int (*kvm_vm_thread_fn_t)(struct kvm *kvm, uintptr_t data);
1346
1347 int kvm_vm_create_worker_thread(struct kvm *kvm, kvm_vm_thread_fn_t thread_fn,
1348                                 uintptr_t data, const char *name,
1349                                 struct task_struct **thread_ptr);
1350
1351 #endif