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