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