arch/x86/kvm/x86.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef ARCH_X86_KVM_X86_H
   3 #define ARCH_X86_KVM_X86_H
   4
   5 #include <linux/kvm_host.h>
   6 #include <asm/mce.h>
   7 #include <asm/pvclock.h>
   8 #include "kvm_cache_regs.h"
   9 #include "kvm_emulate.h"
  10
  11 struct kvm_caps {
  12         /* control of guest tsc rate supported? */
  13         bool has_tsc_control;
  14         /* maximum supported tsc_khz for guests */
  15         u32  max_guest_tsc_khz;
  16         /* number of bits of the fractional part of the TSC scaling ratio */
  17         u8   tsc_scaling_ratio_frac_bits;
  18         /* maximum allowed value of TSC scaling ratio */
  19         u64  max_tsc_scaling_ratio;
  20         /* 1ull << kvm_caps.tsc_scaling_ratio_frac_bits */
  21         u64  default_tsc_scaling_ratio;
  22         /* bus lock detection supported? */
  23         bool has_bus_lock_exit;
  24         /* notify VM exit supported? */
  25         bool has_notify_vmexit;
  26
  27         u64 supported_mce_cap;
  28         u64 supported_xcr0;
  29         u64 supported_xss;
  30         u64 supported_perf_cap;
  31 };
  32
  33 void kvm_spurious_fault(void);
  34
  35 #define KVM_NESTED_VMENTER_CONSISTENCY_CHECK(consistency_check)         \
  36 ({                                                                      \
  37         bool failed = (consistency_check);                              \
  38         if (failed)                                                     \
  39                 trace_kvm_nested_vmenter_failed(#consistency_check, 0); \
  40         failed;                                                         \
  41 })
  42
  43 #define KVM_DEFAULT_PLE_GAP             128
  44 #define KVM_VMX_DEFAULT_PLE_WINDOW      4096
  45 #define KVM_DEFAULT_PLE_WINDOW_GROW     2
  46 #define KVM_DEFAULT_PLE_WINDOW_SHRINK   0
  47 #define KVM_VMX_DEFAULT_PLE_WINDOW_MAX  UINT_MAX
  48 #define KVM_SVM_DEFAULT_PLE_WINDOW_MAX  USHRT_MAX
  49 #define KVM_SVM_DEFAULT_PLE_WINDOW      3000
  50
  51 static inline unsigned int __grow_ple_window(unsigned int val,
  52                 unsigned int base, unsigned int modifier, unsigned int max)
  53 {
  54         u64 ret = val;
  55
  56         if (modifier < 1)
  57                 return base;
  58
  59         if (modifier < base)
  60                 ret *= modifier;
  61         else
  62                 ret += modifier;
  63
  64         return min(ret, (u64)max);
  65 }
  66
  67 static inline unsigned int __shrink_ple_window(unsigned int val,
  68                 unsigned int base, unsigned int modifier, unsigned int min)
  69 {
  70         if (modifier < 1)
  71                 return base;
  72
  73         if (modifier < base)
  74                 val /= modifier;
  75         else
  76                 val -= modifier;
  77
  78         return max(val, min);
  79 }
  80
  81 #define MSR_IA32_CR_PAT_DEFAULT  0x0007040600070406ULL
  82
  83 void kvm_service_local_tlb_flush_requests(struct kvm_vcpu *vcpu);
  84 int kvm_check_nested_events(struct kvm_vcpu *vcpu);
  85
  86 static inline bool kvm_is_exception_pending(struct kvm_vcpu *vcpu)
  87 {
  88         return vcpu->arch.exception.pending ||
  89                vcpu->arch.exception_vmexit.pending ||
  90                kvm_test_request(KVM_REQ_TRIPLE_FAULT, vcpu);
  91 }
  92
  93 static inline void kvm_clear_exception_queue(struct kvm_vcpu *vcpu)
  94 {
  95         vcpu->arch.exception.pending = false;
  96         vcpu->arch.exception.injected = false;
  97         vcpu->arch.exception_vmexit.pending = false;
  98 }
  99
 100 static inline void kvm_queue_interrupt(struct kvm_vcpu *vcpu, u8 vector,
 101         bool soft)
 102 {
 103         vcpu->arch.interrupt.injected = true;
 104         vcpu->arch.interrupt.soft = soft;
 105         vcpu->arch.interrupt.nr = vector;
 106 }
 107
 108 static inline void kvm_clear_interrupt_queue(struct kvm_vcpu *vcpu)
 109 {
 110         vcpu->arch.interrupt.injected = false;
 111 }
 112
 113 static inline bool kvm_event_needs_reinjection(struct kvm_vcpu *vcpu)
 114 {
 115         return vcpu->arch.exception.injected || vcpu->arch.interrupt.injected ||
 116                 vcpu->arch.nmi_injected;
 117 }
 118
 119 static inline bool kvm_exception_is_soft(unsigned int nr)
 120 {
 121         return (nr == BP_VECTOR) || (nr == OF_VECTOR);
 122 }
 123
 124 static inline bool is_protmode(struct kvm_vcpu *vcpu)
 125 {
 126         return kvm_read_cr0_bits(vcpu, X86_CR0_PE);
 127 }
 128
 129 static inline int is_long_mode(struct kvm_vcpu *vcpu)
 130 {
 131 #ifdef CONFIG_X86_64
 132         return vcpu->arch.efer & EFER_LMA;
 133 #else
 134         return 0;
 135 #endif
 136 }
 137
 138 static inline bool is_64_bit_mode(struct kvm_vcpu *vcpu)
 139 {
 140         int cs_db, cs_l;
 141
 142         WARN_ON_ONCE(vcpu->arch.guest_state_protected);
 143
 144         if (!is_long_mode(vcpu))
 145                 return false;
 146         static_call(kvm_x86_get_cs_db_l_bits)(vcpu, &cs_db, &cs_l);
 147         return cs_l;
 148 }
 149
 150 static inline bool is_64_bit_hypercall(struct kvm_vcpu *vcpu)
 151 {
 152         /*
 153          * If running with protected guest state, the CS register is not
 154          * accessible. The hypercall register values will have had to been
 155          * provided in 64-bit mode, so assume the guest is in 64-bit.
 156          */
 157         return vcpu->arch.guest_state_protected || is_64_bit_mode(vcpu);
 158 }
 159
 160 static inline bool x86_exception_has_error_code(unsigned int vector)
 161 {
 162         static u32 exception_has_error_code = BIT(DF_VECTOR) | BIT(TS_VECTOR) |
 163                         BIT(NP_VECTOR) | BIT(SS_VECTOR) | BIT(GP_VECTOR) |
 164                         BIT(PF_VECTOR) | BIT(AC_VECTOR);
 165
 166         return (1U << vector) & exception_has_error_code;
 167 }
 168
 169 static inline bool mmu_is_nested(struct kvm_vcpu *vcpu)
 170 {
 171         return vcpu->arch.walk_mmu == &vcpu->arch.nested_mmu;
 172 }
 173
 174 static inline int is_pae(struct kvm_vcpu *vcpu)
 175 {
 176         return kvm_read_cr4_bits(vcpu, X86_CR4_PAE);
 177 }
 178
 179 static inline int is_pse(struct kvm_vcpu *vcpu)
 180 {
 181         return kvm_read_cr4_bits(vcpu, X86_CR4_PSE);
 182 }
 183
 184 static inline int is_paging(struct kvm_vcpu *vcpu)
 185 {
 186         return likely(kvm_read_cr0_bits(vcpu, X86_CR0_PG));
 187 }
 188
 189 static inline bool is_pae_paging(struct kvm_vcpu *vcpu)
 190 {
 191         return !is_long_mode(vcpu) && is_pae(vcpu) && is_paging(vcpu);
 192 }
 193
 194 static inline u8 vcpu_virt_addr_bits(struct kvm_vcpu *vcpu)
 195 {
 196         return kvm_read_cr4_bits(vcpu, X86_CR4_LA57) ? 57 : 48;
 197 }
 198
 199 static inline bool is_noncanonical_address(u64 la, struct kvm_vcpu *vcpu)
 200 {
 201         return !__is_canonical_address(la, vcpu_virt_addr_bits(vcpu));
 202 }
 203
 204 static inline void vcpu_cache_mmio_info(struct kvm_vcpu *vcpu,
 205                                         gva_t gva, gfn_t gfn, unsigned access)
 206 {
 207         u64 gen = kvm_memslots(vcpu->kvm)->generation;
 208
 209         if (unlikely(gen & KVM_MEMSLOT_GEN_UPDATE_IN_PROGRESS))
 210                 return;
 211
 212         /*
 213          * If this is a shadow nested page table, the "GVA" is
 214          * actually a nGPA.
 215          */
 216         vcpu->arch.mmio_gva = mmu_is_nested(vcpu) ? 0 : gva & PAGE_MASK;
 217         vcpu->arch.mmio_access = access;
 218         vcpu->arch.mmio_gfn = gfn;
 219         vcpu->arch.mmio_gen = gen;
 220 }
 221
 222 static inline bool vcpu_match_mmio_gen(struct kvm_vcpu *vcpu)
 223 {
 224         return vcpu->arch.mmio_gen == kvm_memslots(vcpu->kvm)->generation;
 225 }
 226
 227 /*
 228  * Clear the mmio cache info for the given gva. If gva is MMIO_GVA_ANY, we
 229  * clear all mmio cache info.
 230  */
 231 #define MMIO_GVA_ANY (~(gva_t)0)
 232
 233 static inline void vcpu_clear_mmio_info(struct kvm_vcpu *vcpu, gva_t gva)
 234 {
 235         if (gva != MMIO_GVA_ANY && vcpu->arch.mmio_gva != (gva & PAGE_MASK))
 236                 return;
 237
 238         vcpu->arch.mmio_gva = 0;
 239 }
 240
 241 static inline bool vcpu_match_mmio_gva(struct kvm_vcpu *vcpu, unsigned long gva)
 242 {
 243         if (vcpu_match_mmio_gen(vcpu) && vcpu->arch.mmio_gva &&
 244               vcpu->arch.mmio_gva == (gva & PAGE_MASK))
 245                 return true;
 246
 247         return false;
 248 }
 249
 250 static inline bool vcpu_match_mmio_gpa(struct kvm_vcpu *vcpu, gpa_t gpa)
 251 {
 252         if (vcpu_match_mmio_gen(vcpu) && vcpu->arch.mmio_gfn &&
 253               vcpu->arch.mmio_gfn == gpa >> PAGE_SHIFT)
 254                 return true;
 255
 256         return false;
 257 }
 258
 259 static inline unsigned long kvm_register_read(struct kvm_vcpu *vcpu, int reg)
 260 {
 261         unsigned long val = kvm_register_read_raw(vcpu, reg);
 262
 263         return is_64_bit_mode(vcpu) ? val : (u32)val;
 264 }
 265
 266 static inline void kvm_register_write(struct kvm_vcpu *vcpu,
 267                                        int reg, unsigned long val)
 268 {
 269         if (!is_64_bit_mode(vcpu))
 270                 val = (u32)val;
 271         return kvm_register_write_raw(vcpu, reg, val);
 272 }
 273
 274 static inline bool kvm_check_has_quirk(struct kvm *kvm, u64 quirk)
 275 {
 276         return !(kvm->arch.disabled_quirks & quirk);
 277 }
 278
 279 void kvm_inject_realmode_interrupt(struct kvm_vcpu *vcpu, int irq, int inc_eip);
 280
 281 u64 get_kvmclock_ns(struct kvm *kvm);
 282
 283 int kvm_read_guest_virt(struct kvm_vcpu *vcpu,
 284         gva_t addr, void *val, unsigned int bytes,
 285         struct x86_exception *exception);
 286
 287 int kvm_write_guest_virt_system(struct kvm_vcpu *vcpu,
 288         gva_t addr, void *val, unsigned int bytes,
 289         struct x86_exception *exception);
 290
 291 int handle_ud(struct kvm_vcpu *vcpu);
 292
 293 void kvm_deliver_exception_payload(struct kvm_vcpu *vcpu,
 294                                    struct kvm_queued_exception *ex);
 295
 296 void kvm_vcpu_mtrr_init(struct kvm_vcpu *vcpu);
 297 u8 kvm_mtrr_get_guest_memory_type(struct kvm_vcpu *vcpu, gfn_t gfn);
 298 bool kvm_mtrr_valid(struct kvm_vcpu *vcpu, u32 msr, u64 data);
 299 int kvm_mtrr_set_msr(struct kvm_vcpu *vcpu, u32 msr, u64 data);
 300 int kvm_mtrr_get_msr(struct kvm_vcpu *vcpu, u32 msr, u64 *pdata);
 301 bool kvm_mtrr_check_gfn_range_consistency(struct kvm_vcpu *vcpu, gfn_t gfn,
 302                                           int page_num);
 303 bool kvm_vector_hashing_enabled(void);
 304 void kvm_fixup_and_inject_pf_error(struct kvm_vcpu *vcpu, gva_t gva, u16 error_code);
 305 int x86_decode_emulated_instruction(struct kvm_vcpu *vcpu, int emulation_type,
 306                                     void *insn, int insn_len);
 307 int x86_emulate_instruction(struct kvm_vcpu *vcpu, gpa_t cr2_or_gpa,
 308                             int emulation_type, void *insn, int insn_len);
 309 fastpath_t handle_fastpath_set_msr_irqoff(struct kvm_vcpu *vcpu);
 310
 311 extern u64 host_xcr0;
 312 extern u64 host_xss;
 313
 314 extern struct kvm_caps kvm_caps;
 315
 316 extern bool enable_pmu;
 317
 318 static inline bool kvm_mpx_supported(void)
 319 {
 320         return (kvm_caps.supported_xcr0 & (XFEATURE_MASK_BNDREGS | XFEATURE_MASK_BNDCSR))
 321                 == (XFEATURE_MASK_BNDREGS | XFEATURE_MASK_BNDCSR);
 322 }
 323
 324 extern unsigned int min_timer_period_us;
 325
 326 extern bool enable_vmware_backdoor;
 327
 328 extern int pi_inject_timer;
 329
 330 extern bool report_ignored_msrs;
 331
 332 extern bool eager_page_split;
 333
 334 static inline void kvm_pr_unimpl_wrmsr(struct kvm_vcpu *vcpu, u32 msr, u64 data)
 335 {
 336         if (report_ignored_msrs)
 337                 vcpu_unimpl(vcpu, "Unhandled WRMSR(0x%x) = 0x%llx\n", msr, data);
 338 }
 339
 340 static inline void kvm_pr_unimpl_rdmsr(struct kvm_vcpu *vcpu, u32 msr)
 341 {
 342         if (report_ignored_msrs)
 343                 vcpu_unimpl(vcpu, "Unhandled RDMSR(0x%x)\n", msr);
 344 }
 345
 346 static inline u64 nsec_to_cycles(struct kvm_vcpu *vcpu, u64 nsec)
 347 {
 348         return pvclock_scale_delta(nsec, vcpu->arch.virtual_tsc_mult,
 349                                    vcpu->arch.virtual_tsc_shift);
 350 }
 351
 352 /* Same "calling convention" as do_div:
 353  * - divide (n << 32) by base
 354  * - put result in n
 355  * - return remainder
 356  */
 357 #define do_shl32_div32(n, base)                                 \
 358         ({                                                      \
 359             u32 __quot, __rem;                                  \
 360             asm("divl %2" : "=a" (__quot), "=d" (__rem)         \
 361                         : "rm" (base), "0" (0), "1" ((u32) n)); \
 362             n = __quot;                                         \
 363             __rem;                                              \
 364          })
 365
 366 static inline bool kvm_mwait_in_guest(struct kvm *kvm)
 367 {
 368         return kvm->arch.mwait_in_guest;
 369 }
 370
 371 static inline bool kvm_hlt_in_guest(struct kvm *kvm)
 372 {
 373         return kvm->arch.hlt_in_guest;
 374 }
 375
 376 static inline bool kvm_pause_in_guest(struct kvm *kvm)
 377 {
 378         return kvm->arch.pause_in_guest;
 379 }
 380
 381 static inline bool kvm_cstate_in_guest(struct kvm *kvm)
 382 {
 383         return kvm->arch.cstate_in_guest;
 384 }
 385
 386 static inline bool kvm_notify_vmexit_enabled(struct kvm *kvm)
 387 {
 388         return kvm->arch.notify_vmexit_flags & KVM_X86_NOTIFY_VMEXIT_ENABLED;
 389 }
 390
 391 enum kvm_intr_type {
 392         /* Values are arbitrary, but must be non-zero. */
 393         KVM_HANDLING_IRQ = 1,
 394         KVM_HANDLING_NMI,
 395 };
 396
 397 static inline void kvm_before_interrupt(struct kvm_vcpu *vcpu,
 398                                         enum kvm_intr_type intr)
 399 {
 400         WRITE_ONCE(vcpu->arch.handling_intr_from_guest, (u8)intr);
 401 }
 402
 403 static inline void kvm_after_interrupt(struct kvm_vcpu *vcpu)
 404 {
 405         WRITE_ONCE(vcpu->arch.handling_intr_from_guest, 0);
 406 }
 407
 408 static inline bool kvm_handling_nmi_from_guest(struct kvm_vcpu *vcpu)
 409 {
 410         return vcpu->arch.handling_intr_from_guest == KVM_HANDLING_NMI;
 411 }
 412
 413 static inline bool kvm_pat_valid(u64 data)
 414 {
 415         if (data & 0xF8F8F8F8F8F8F8F8ull)
 416                 return false;
 417         /* 0, 1, 4, 5, 6, 7 are valid values.  */
 418         return (data | ((data & 0x0202020202020202ull) << 1)) == data;
 419 }
 420
 421 static inline bool kvm_dr7_valid(u64 data)
 422 {
 423         /* Bits [63:32] are reserved */
 424         return !(data >> 32);
 425 }
 426 static inline bool kvm_dr6_valid(u64 data)
 427 {
 428         /* Bits [63:32] are reserved */
 429         return !(data >> 32);
 430 }
 431
 432 /*
 433  * Trigger machine check on the host. We assume all the MSRs are already set up
 434  * by the CPU and that we still run on the same CPU as the MCE occurred on.
 435  * We pass a fake environment to the machine check handler because we want
 436  * the guest to be always treated like user space, no matter what context
 437  * it used internally.
 438  */
 439 static inline void kvm_machine_check(void)
 440 {
 441 #if defined(CONFIG_X86_MCE)
 442         struct pt_regs regs = {
 443                 .cs = 3, /* Fake ring 3 no matter what the guest ran on */
 444                 .flags = X86_EFLAGS_IF,
 445         };
 446
 447         do_machine_check(&regs);
 448 #endif
 449 }
 450
 451 void kvm_load_guest_xsave_state(struct kvm_vcpu *vcpu);
 452 void kvm_load_host_xsave_state(struct kvm_vcpu *vcpu);
 453 int kvm_spec_ctrl_test_value(u64 value);
 454 bool __kvm_is_valid_cr4(struct kvm_vcpu *vcpu, unsigned long cr4);
 455 int kvm_handle_memory_failure(struct kvm_vcpu *vcpu, int r,
 456                               struct x86_exception *e);
 457 int kvm_handle_invpcid(struct kvm_vcpu *vcpu, unsigned long type, gva_t gva);
 458 bool kvm_msr_allowed(struct kvm_vcpu *vcpu, u32 index, u32 type);
 459
 460 /*
 461  * Internal error codes that are used to indicate that MSR emulation encountered
 462  * an error that should result in #GP in the guest, unless userspace
 463  * handles it.
 464  */
 465 #define  KVM_MSR_RET_INVALID    2       /* in-kernel MSR emulation #GP condition */
 466 #define  KVM_MSR_RET_FILTERED   3       /* #GP due to userspace MSR filter */
 467
 468 #define __cr4_reserved_bits(__cpu_has, __c)             \
 469 ({                                                      \
 470         u64 __reserved_bits = CR4_RESERVED_BITS;        \
 471                                                         \
 472         if (!__cpu_has(__c, X86_FEATURE_XSAVE))         \
 473                 __reserved_bits |= X86_CR4_OSXSAVE;     \
 474         if (!__cpu_has(__c, X86_FEATURE_SMEP))          \
 475                 __reserved_bits |= X86_CR4_SMEP;        \
 476         if (!__cpu_has(__c, X86_FEATURE_SMAP))          \
 477                 __reserved_bits |= X86_CR4_SMAP;        \
 478         if (!__cpu_has(__c, X86_FEATURE_FSGSBASE))      \
 479                 __reserved_bits |= X86_CR4_FSGSBASE;    \
 480         if (!__cpu_has(__c, X86_FEATURE_PKU))           \
 481                 __reserved_bits |= X86_CR4_PKE;         \
 482         if (!__cpu_has(__c, X86_FEATURE_LA57))          \
 483                 __reserved_bits |= X86_CR4_LA57;        \
 484         if (!__cpu_has(__c, X86_FEATURE_UMIP))          \
 485                 __reserved_bits |= X86_CR4_UMIP;        \
 486         if (!__cpu_has(__c, X86_FEATURE_VMX))           \
 487                 __reserved_bits |= X86_CR4_VMXE;        \
 488         if (!__cpu_has(__c, X86_FEATURE_PCID))          \
 489                 __reserved_bits |= X86_CR4_PCIDE;       \
 490         __reserved_bits;                                \
 491 })
 492
 493 int kvm_sev_es_mmio_write(struct kvm_vcpu *vcpu, gpa_t src, unsigned int bytes,
 494                           void *dst);
 495 int kvm_sev_es_mmio_read(struct kvm_vcpu *vcpu, gpa_t src, unsigned int bytes,
 496                          void *dst);
 497 int kvm_sev_es_string_io(struct kvm_vcpu *vcpu, unsigned int size,
 498                          unsigned int port, void *data,  unsigned int count,
 499                          int in);
 500
 501 #endif