1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2021, Red Hat, Inc.
5 * Tests for Hyper-V features enablement
7 #include <asm/kvm_para.h>
8 #include <linux/kvm_para.h>
11 #include "test_util.h"
13 #include "processor.h"
16 #define LINUX_OS_ID ((u64)0x8100 << 48)
18 static inline uint8_t hypercall(u64 control, vm_vaddr_t input_address,
19 vm_vaddr_t output_address, uint64_t *hv_status)
23 /* Note both the hypercall and the "asm safe" clobber r9-r11. */
24 asm volatile("mov %[output_address], %%r8\n\t"
25 KVM_ASM_SAFE("vmcall")
27 "+c" (control), "+d" (input_address),
28 KVM_ASM_SAFE_OUTPUTS(vector)
29 : [output_address] "r"(output_address)
30 : "cc", "memory", "r8", KVM_ASM_SAFE_CLOBBERS);
47 static void guest_msr(struct msr_data *msr)
52 GUEST_ASSERT(msr->idx);
55 vector = rdmsr_safe(msr->idx, &ignored);
57 vector = wrmsr_safe(msr->idx, msr->write_val);
60 GUEST_ASSERT_2(!vector, msr->idx, vector);
62 GUEST_ASSERT_2(vector == GP_VECTOR, msr->idx, vector);
66 static void guest_hcall(vm_vaddr_t pgs_gpa, struct hcall_data *hcall)
68 u64 res, input, output;
71 GUEST_ASSERT(hcall->control);
73 wrmsr(HV_X64_MSR_GUEST_OS_ID, LINUX_OS_ID);
74 wrmsr(HV_X64_MSR_HYPERCALL, pgs_gpa);
76 if (!(hcall->control & HV_HYPERCALL_FAST_BIT)) {
78 output = pgs_gpa + 4096;
83 vector = hypercall(hcall->control, input, output, &res);
84 if (hcall->ud_expected)
85 GUEST_ASSERT_2(vector == UD_VECTOR, hcall->control, vector);
87 GUEST_ASSERT_2(!vector, hcall->control, vector);
89 GUEST_ASSERT_2(!hcall->ud_expected || res == hcall->expect,
94 static void vcpu_reset_hv_cpuid(struct kvm_vcpu *vcpu)
97 * Enable all supported Hyper-V features, then clear the leafs holding
98 * the features that will be tested one by one.
100 vcpu_set_hv_cpuid(vcpu);
102 vcpu_clear_cpuid_entry(vcpu, HYPERV_CPUID_FEATURES);
103 vcpu_clear_cpuid_entry(vcpu, HYPERV_CPUID_ENLIGHTMENT_INFO);
104 vcpu_clear_cpuid_entry(vcpu, HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES);
107 static void guest_test_msrs_access(void)
109 struct kvm_cpuid2 *prev_cpuid = NULL;
110 struct kvm_cpuid_entry2 *feat, *dbg;
111 struct kvm_vcpu *vcpu;
117 struct msr_data *msr;
120 vm = vm_create_with_one_vcpu(&vcpu, guest_msr);
122 msr_gva = vm_vaddr_alloc_page(vm);
123 memset(addr_gva2hva(vm, msr_gva), 0x0, getpagesize());
124 msr = addr_gva2hva(vm, msr_gva);
126 vcpu_args_set(vcpu, 1, msr_gva);
127 vcpu_enable_cap(vcpu, KVM_CAP_HYPERV_ENFORCE_CPUID, 1);
130 vcpu_reset_hv_cpuid(vcpu);
132 prev_cpuid = allocate_kvm_cpuid2(vcpu->cpuid->nent);
134 vcpu_init_cpuid(vcpu, prev_cpuid);
137 feat = vcpu_get_cpuid_entry(vcpu, HYPERV_CPUID_FEATURES);
138 dbg = vcpu_get_cpuid_entry(vcpu, HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES);
140 vm_init_descriptor_tables(vm);
141 vcpu_init_descriptor_tables(vcpu);
145 /* TODO: Make this entire test easier to maintain. */
147 vcpu_enable_cap(vcpu, KVM_CAP_HYPERV_SYNIC2, 0);
152 * Only available when Hyper-V identification is set
154 msr->idx = HV_X64_MSR_GUEST_OS_ID;
159 msr->idx = HV_X64_MSR_HYPERCALL;
164 feat->eax |= HV_MSR_HYPERCALL_AVAILABLE;
166 * HV_X64_MSR_GUEST_OS_ID has to be written first to make
167 * HV_X64_MSR_HYPERCALL available.
169 msr->idx = HV_X64_MSR_GUEST_OS_ID;
171 msr->write_val = LINUX_OS_ID;
175 msr->idx = HV_X64_MSR_GUEST_OS_ID;
180 msr->idx = HV_X64_MSR_HYPERCALL;
186 msr->idx = HV_X64_MSR_VP_RUNTIME;
191 feat->eax |= HV_MSR_VP_RUNTIME_AVAILABLE;
192 msr->idx = HV_X64_MSR_VP_RUNTIME;
198 msr->idx = HV_X64_MSR_VP_RUNTIME;
205 msr->idx = HV_X64_MSR_TIME_REF_COUNT;
210 feat->eax |= HV_MSR_TIME_REF_COUNT_AVAILABLE;
211 msr->idx = HV_X64_MSR_TIME_REF_COUNT;
217 msr->idx = HV_X64_MSR_TIME_REF_COUNT;
224 msr->idx = HV_X64_MSR_VP_INDEX;
229 feat->eax |= HV_MSR_VP_INDEX_AVAILABLE;
230 msr->idx = HV_X64_MSR_VP_INDEX;
236 msr->idx = HV_X64_MSR_VP_INDEX;
243 msr->idx = HV_X64_MSR_RESET;
248 feat->eax |= HV_MSR_RESET_AVAILABLE;
249 msr->idx = HV_X64_MSR_RESET;
254 msr->idx = HV_X64_MSR_RESET;
261 msr->idx = HV_X64_MSR_REFERENCE_TSC;
266 feat->eax |= HV_MSR_REFERENCE_TSC_AVAILABLE;
267 msr->idx = HV_X64_MSR_REFERENCE_TSC;
272 msr->idx = HV_X64_MSR_REFERENCE_TSC;
279 msr->idx = HV_X64_MSR_EOM;
285 * Remains unavailable even with KVM_CAP_HYPERV_SYNIC2
286 * capability enabled and guest visible CPUID bit unset.
288 msr->idx = HV_X64_MSR_EOM;
293 feat->eax |= HV_MSR_SYNIC_AVAILABLE;
294 msr->idx = HV_X64_MSR_EOM;
299 msr->idx = HV_X64_MSR_EOM;
306 msr->idx = HV_X64_MSR_STIMER0_CONFIG;
311 feat->eax |= HV_MSR_SYNTIMER_AVAILABLE;
312 msr->idx = HV_X64_MSR_STIMER0_CONFIG;
317 msr->idx = HV_X64_MSR_STIMER0_CONFIG;
323 /* Direct mode test */
324 msr->idx = HV_X64_MSR_STIMER0_CONFIG;
326 msr->write_val = 1 << 12;
330 feat->edx |= HV_STIMER_DIRECT_MODE_AVAILABLE;
331 msr->idx = HV_X64_MSR_STIMER0_CONFIG;
333 msr->write_val = 1 << 12;
338 msr->idx = HV_X64_MSR_EOI;
343 feat->eax |= HV_MSR_APIC_ACCESS_AVAILABLE;
344 msr->idx = HV_X64_MSR_EOI;
351 msr->idx = HV_X64_MSR_TSC_FREQUENCY;
356 feat->eax |= HV_ACCESS_FREQUENCY_MSRS;
357 msr->idx = HV_X64_MSR_TSC_FREQUENCY;
363 msr->idx = HV_X64_MSR_TSC_FREQUENCY;
370 msr->idx = HV_X64_MSR_REENLIGHTENMENT_CONTROL;
375 feat->eax |= HV_ACCESS_REENLIGHTENMENT;
376 msr->idx = HV_X64_MSR_REENLIGHTENMENT_CONTROL;
381 msr->idx = HV_X64_MSR_REENLIGHTENMENT_CONTROL;
387 /* Can only write '0' */
388 msr->idx = HV_X64_MSR_TSC_EMULATION_STATUS;
395 msr->idx = HV_X64_MSR_CRASH_P0;
400 feat->edx |= HV_FEATURE_GUEST_CRASH_MSR_AVAILABLE;
401 msr->idx = HV_X64_MSR_CRASH_P0;
406 msr->idx = HV_X64_MSR_CRASH_P0;
413 msr->idx = HV_X64_MSR_SYNDBG_STATUS;
418 feat->edx |= HV_FEATURE_DEBUG_MSRS_AVAILABLE;
419 dbg->eax |= HV_X64_SYNDBG_CAP_ALLOW_KERNEL_DEBUGGING;
420 msr->idx = HV_X64_MSR_SYNDBG_STATUS;
425 msr->idx = HV_X64_MSR_SYNDBG_STATUS;
436 vcpu_set_cpuid(vcpu);
438 memcpy(prev_cpuid, vcpu->cpuid, kvm_cpuid2_size(vcpu->cpuid->nent));
440 pr_debug("Stage %d: testing msr: 0x%x for %s\n", stage,
441 msr->idx, msr->write ? "write" : "read");
444 TEST_ASSERT(run->exit_reason == KVM_EXIT_IO,
445 "unexpected exit reason: %u (%s)",
446 run->exit_reason, exit_reason_str(run->exit_reason));
448 switch (get_ucall(vcpu, &uc)) {
450 REPORT_GUEST_ASSERT_2(uc, "MSR = %lx, vector = %lx");
455 TEST_FAIL("Unhandled ucall: %ld", uc.cmd);
464 static void guest_test_hcalls_access(void)
466 struct kvm_cpuid_entry2 *feat, *recomm, *dbg;
467 struct kvm_cpuid2 *prev_cpuid = NULL;
468 struct kvm_vcpu *vcpu;
473 vm_vaddr_t hcall_page, hcall_params;
474 struct hcall_data *hcall;
477 vm = vm_create_with_one_vcpu(&vcpu, guest_hcall);
479 vm_init_descriptor_tables(vm);
480 vcpu_init_descriptor_tables(vcpu);
482 /* Hypercall input/output */
483 hcall_page = vm_vaddr_alloc_pages(vm, 2);
484 memset(addr_gva2hva(vm, hcall_page), 0x0, 2 * getpagesize());
486 hcall_params = vm_vaddr_alloc_page(vm);
487 memset(addr_gva2hva(vm, hcall_params), 0x0, getpagesize());
488 hcall = addr_gva2hva(vm, hcall_params);
490 vcpu_args_set(vcpu, 2, addr_gva2gpa(vm, hcall_page), hcall_params);
491 vcpu_enable_cap(vcpu, KVM_CAP_HYPERV_ENFORCE_CPUID, 1);
494 vcpu_reset_hv_cpuid(vcpu);
496 prev_cpuid = allocate_kvm_cpuid2(vcpu->cpuid->nent);
498 vcpu_init_cpuid(vcpu, prev_cpuid);
501 feat = vcpu_get_cpuid_entry(vcpu, HYPERV_CPUID_FEATURES);
502 recomm = vcpu_get_cpuid_entry(vcpu, HYPERV_CPUID_ENLIGHTMENT_INFO);
503 dbg = vcpu_get_cpuid_entry(vcpu, HYPERV_CPUID_SYNDBG_PLATFORM_CAPABILITIES);
509 feat->eax |= HV_MSR_HYPERCALL_AVAILABLE;
510 hcall->control = 0xdeadbeef;
511 hcall->expect = HV_STATUS_INVALID_HYPERCALL_CODE;
515 hcall->control = HVCALL_POST_MESSAGE;
516 hcall->expect = HV_STATUS_ACCESS_DENIED;
519 feat->ebx |= HV_POST_MESSAGES;
520 hcall->control = HVCALL_POST_MESSAGE;
521 hcall->expect = HV_STATUS_INVALID_HYPERCALL_INPUT;
525 hcall->control = HVCALL_SIGNAL_EVENT;
526 hcall->expect = HV_STATUS_ACCESS_DENIED;
529 feat->ebx |= HV_SIGNAL_EVENTS;
530 hcall->control = HVCALL_SIGNAL_EVENT;
531 hcall->expect = HV_STATUS_INVALID_HYPERCALL_INPUT;
535 hcall->control = HVCALL_RESET_DEBUG_SESSION;
536 hcall->expect = HV_STATUS_INVALID_HYPERCALL_CODE;
539 dbg->eax |= HV_X64_SYNDBG_CAP_ALLOW_KERNEL_DEBUGGING;
540 hcall->control = HVCALL_RESET_DEBUG_SESSION;
541 hcall->expect = HV_STATUS_ACCESS_DENIED;
544 feat->ebx |= HV_DEBUGGING;
545 hcall->control = HVCALL_RESET_DEBUG_SESSION;
546 hcall->expect = HV_STATUS_OPERATION_DENIED;
550 hcall->control = HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE;
551 hcall->expect = HV_STATUS_ACCESS_DENIED;
554 recomm->eax |= HV_X64_REMOTE_TLB_FLUSH_RECOMMENDED;
555 hcall->control = HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE;
556 hcall->expect = HV_STATUS_SUCCESS;
559 hcall->control = HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE_EX;
560 hcall->expect = HV_STATUS_ACCESS_DENIED;
563 recomm->eax |= HV_X64_EX_PROCESSOR_MASKS_RECOMMENDED;
564 hcall->control = HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE_EX;
565 hcall->expect = HV_STATUS_SUCCESS;
569 hcall->control = HVCALL_SEND_IPI;
570 hcall->expect = HV_STATUS_ACCESS_DENIED;
573 recomm->eax |= HV_X64_CLUSTER_IPI_RECOMMENDED;
574 hcall->control = HVCALL_SEND_IPI;
575 hcall->expect = HV_STATUS_INVALID_HYPERCALL_INPUT;
578 /* Nothing in 'sparse banks' -> success */
579 hcall->control = HVCALL_SEND_IPI_EX;
580 hcall->expect = HV_STATUS_SUCCESS;
584 hcall->control = HVCALL_NOTIFY_LONG_SPIN_WAIT;
585 hcall->expect = HV_STATUS_ACCESS_DENIED;
589 hcall->control = HVCALL_NOTIFY_LONG_SPIN_WAIT;
590 hcall->expect = HV_STATUS_SUCCESS;
593 /* XMM fast hypercall */
594 hcall->control = HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE | HV_HYPERCALL_FAST_BIT;
595 hcall->ud_expected = true;
598 feat->edx |= HV_X64_HYPERCALL_XMM_INPUT_AVAILABLE;
599 hcall->control = HVCALL_FLUSH_VIRTUAL_ADDRESS_SPACE | HV_HYPERCALL_FAST_BIT;
600 hcall->ud_expected = false;
601 hcall->expect = HV_STATUS_SUCCESS;
608 vcpu_set_cpuid(vcpu);
610 memcpy(prev_cpuid, vcpu->cpuid, kvm_cpuid2_size(vcpu->cpuid->nent));
612 pr_debug("Stage %d: testing hcall: 0x%lx\n", stage, hcall->control);
615 TEST_ASSERT(run->exit_reason == KVM_EXIT_IO,
616 "unexpected exit reason: %u (%s)",
617 run->exit_reason, exit_reason_str(run->exit_reason));
619 switch (get_ucall(vcpu, &uc)) {
621 REPORT_GUEST_ASSERT_2(uc, "arg1 = %lx, arg2 = %lx");
626 TEST_FAIL("Unhandled ucall: %ld", uc.cmd);
637 pr_info("Testing access to Hyper-V specific MSRs\n");
638 guest_test_msrs_access();
640 pr_info("Testing access to Hyper-V hypercalls\n");
641 guest_test_hcalls_access();