1 // SPDX-License-Identifier: GPL-2.0-only
3 * HyperV Detection code.
5 * Copyright (C) 2010, Novell, Inc.
6 * Author : K. Y. Srinivasan <ksrinivasan@novell.com>
9 #include <linux/types.h>
10 #include <linux/time.h>
11 #include <linux/clocksource.h>
12 #include <linux/init.h>
13 #include <linux/export.h>
14 #include <linux/hardirq.h>
15 #include <linux/efi.h>
16 #include <linux/interrupt.h>
17 #include <linux/irq.h>
18 #include <linux/kexec.h>
19 #include <linux/i8253.h>
20 #include <linux/random.h>
21 #include <asm/processor.h>
22 #include <asm/hypervisor.h>
23 #include <asm/hyperv-tlfs.h>
24 #include <asm/mshyperv.h>
26 #include <asm/idtentry.h>
27 #include <asm/irq_regs.h>
28 #include <asm/i8259.h>
30 #include <asm/timer.h>
31 #include <asm/reboot.h>
33 #include <clocksource/hyperv_timer.h>
36 /* Is Linux running as the root partition? */
37 bool hv_root_partition;
38 struct ms_hyperv_info ms_hyperv;
40 #if IS_ENABLED(CONFIG_HYPERV)
41 static void (*vmbus_handler)(void);
42 static void (*hv_stimer0_handler)(void);
43 static void (*hv_kexec_handler)(void);
44 static void (*hv_crash_handler)(struct pt_regs *regs);
46 DEFINE_IDTENTRY_SYSVEC(sysvec_hyperv_callback)
48 struct pt_regs *old_regs = set_irq_regs(regs);
50 inc_irq_stat(irq_hv_callback_count);
54 if (ms_hyperv.hints & HV_DEPRECATING_AEOI_RECOMMENDED)
57 set_irq_regs(old_regs);
60 void hv_setup_vmbus_handler(void (*handler)(void))
62 vmbus_handler = handler;
65 void hv_remove_vmbus_handler(void)
67 /* We have no way to deallocate the interrupt gate */
72 * Routines to do per-architecture handling of stimer0
73 * interrupts when in Direct Mode
75 DEFINE_IDTENTRY_SYSVEC(sysvec_hyperv_stimer0)
77 struct pt_regs *old_regs = set_irq_regs(regs);
79 inc_irq_stat(hyperv_stimer0_count);
80 if (hv_stimer0_handler)
82 add_interrupt_randomness(HYPERV_STIMER0_VECTOR);
85 set_irq_regs(old_regs);
88 /* For x86/x64, override weak placeholders in hyperv_timer.c */
89 void hv_setup_stimer0_handler(void (*handler)(void))
91 hv_stimer0_handler = handler;
94 void hv_remove_stimer0_handler(void)
96 /* We have no way to deallocate the interrupt gate */
97 hv_stimer0_handler = NULL;
100 void hv_setup_kexec_handler(void (*handler)(void))
102 hv_kexec_handler = handler;
105 void hv_remove_kexec_handler(void)
107 hv_kexec_handler = NULL;
110 void hv_setup_crash_handler(void (*handler)(struct pt_regs *regs))
112 hv_crash_handler = handler;
115 void hv_remove_crash_handler(void)
117 hv_crash_handler = NULL;
120 #ifdef CONFIG_KEXEC_CORE
121 static void hv_machine_shutdown(void)
123 if (kexec_in_progress && hv_kexec_handler)
127 * Call hv_cpu_die() on all the CPUs, otherwise later the hypervisor
128 * corrupts the old VP Assist Pages and can crash the kexec kernel.
130 if (kexec_in_progress && hyperv_init_cpuhp > 0)
131 cpuhp_remove_state(hyperv_init_cpuhp);
133 /* The function calls stop_other_cpus(). */
134 native_machine_shutdown();
136 /* Disable the hypercall page when there is only 1 active CPU. */
137 if (kexec_in_progress)
141 static void hv_machine_crash_shutdown(struct pt_regs *regs)
143 if (hv_crash_handler)
144 hv_crash_handler(regs);
146 /* The function calls crash_smp_send_stop(). */
147 native_machine_crash_shutdown(regs);
149 /* Disable the hypercall page when there is only 1 active CPU. */
152 #endif /* CONFIG_KEXEC_CORE */
153 #endif /* CONFIG_HYPERV */
155 static uint32_t __init ms_hyperv_platform(void)
158 u32 hyp_signature[3];
160 if (!boot_cpu_has(X86_FEATURE_HYPERVISOR))
163 cpuid(HYPERV_CPUID_VENDOR_AND_MAX_FUNCTIONS,
164 &eax, &hyp_signature[0], &hyp_signature[1], &hyp_signature[2]);
166 if (eax < HYPERV_CPUID_MIN || eax > HYPERV_CPUID_MAX ||
167 memcmp("Microsoft Hv", hyp_signature, 12))
170 /* HYPERCALL and VP_INDEX MSRs are mandatory for all features. */
171 eax = cpuid_eax(HYPERV_CPUID_FEATURES);
172 if (!(eax & HV_MSR_HYPERCALL_AVAILABLE)) {
173 pr_warn("x86/hyperv: HYPERCALL MSR not available.\n");
176 if (!(eax & HV_MSR_VP_INDEX_AVAILABLE)) {
177 pr_warn("x86/hyperv: VP_INDEX MSR not available.\n");
181 return HYPERV_CPUID_VENDOR_AND_MAX_FUNCTIONS;
184 static unsigned char hv_get_nmi_reason(void)
189 #ifdef CONFIG_X86_LOCAL_APIC
191 * Prior to WS2016 Debug-VM sends NMIs to all CPUs which makes
192 * it difficult to process CHANNELMSG_UNLOAD in case of crash. Handle
193 * unknown NMI on the first CPU which gets it.
195 static int hv_nmi_unknown(unsigned int val, struct pt_regs *regs)
197 static atomic_t nmi_cpu = ATOMIC_INIT(-1);
199 if (!unknown_nmi_panic)
202 if (atomic_cmpxchg(&nmi_cpu, -1, raw_smp_processor_id()) != -1)
209 static unsigned long hv_get_tsc_khz(void)
213 rdmsrl(HV_X64_MSR_TSC_FREQUENCY, freq);
218 #if defined(CONFIG_SMP) && IS_ENABLED(CONFIG_HYPERV)
219 static void __init hv_smp_prepare_boot_cpu(void)
221 native_smp_prepare_boot_cpu();
222 #if defined(CONFIG_X86_64) && defined(CONFIG_PARAVIRT_SPINLOCKS)
227 static void __init hv_smp_prepare_cpus(unsigned int max_cpus)
234 native_smp_prepare_cpus(max_cpus);
237 for_each_present_cpu(i) {
240 ret = hv_call_add_logical_proc(numa_cpu_node(i), i, cpu_physical_id(i));
244 for_each_present_cpu(i) {
247 ret = hv_call_create_vp(numa_cpu_node(i), hv_current_partition_id, i, i);
254 static void __init ms_hyperv_init_platform(void)
256 int hv_max_functions_eax;
257 int hv_host_info_eax;
258 int hv_host_info_ebx;
259 int hv_host_info_ecx;
260 int hv_host_info_edx;
262 #ifdef CONFIG_PARAVIRT
263 pv_info.name = "Hyper-V";
267 * Extract the features and hints
269 ms_hyperv.features = cpuid_eax(HYPERV_CPUID_FEATURES);
270 ms_hyperv.priv_high = cpuid_ebx(HYPERV_CPUID_FEATURES);
271 ms_hyperv.misc_features = cpuid_edx(HYPERV_CPUID_FEATURES);
272 ms_hyperv.hints = cpuid_eax(HYPERV_CPUID_ENLIGHTMENT_INFO);
274 hv_max_functions_eax = cpuid_eax(HYPERV_CPUID_VENDOR_AND_MAX_FUNCTIONS);
276 pr_info("Hyper-V: privilege flags low 0x%x, high 0x%x, hints 0x%x, misc 0x%x\n",
277 ms_hyperv.features, ms_hyperv.priv_high, ms_hyperv.hints,
278 ms_hyperv.misc_features);
280 ms_hyperv.max_vp_index = cpuid_eax(HYPERV_CPUID_IMPLEMENT_LIMITS);
281 ms_hyperv.max_lp_index = cpuid_ebx(HYPERV_CPUID_IMPLEMENT_LIMITS);
283 pr_debug("Hyper-V: max %u virtual processors, %u logical processors\n",
284 ms_hyperv.max_vp_index, ms_hyperv.max_lp_index);
287 * Check CPU management privilege.
289 * To mirror what Windows does we should extract CPU management
290 * features and use the ReservedIdentityBit to detect if Linux is the
291 * root partition. But that requires negotiating CPU management
292 * interface (a process to be finalized). For now, use the privilege
293 * flag as the indicator for running as root.
295 * Hyper-V should never specify running as root and as a Confidential
296 * VM. But to protect against a compromised/malicious Hyper-V trying
297 * to exploit root behavior to expose Confidential VM memory, ignore
298 * the root partition setting if also a Confidential VM.
300 if ((ms_hyperv.priv_high & HV_CPU_MANAGEMENT) &&
301 !(ms_hyperv.priv_high & HV_ISOLATION)) {
302 hv_root_partition = true;
303 pr_info("Hyper-V: running as root partition\n");
307 * Extract host information.
309 if (hv_max_functions_eax >= HYPERV_CPUID_VERSION) {
310 hv_host_info_eax = cpuid_eax(HYPERV_CPUID_VERSION);
311 hv_host_info_ebx = cpuid_ebx(HYPERV_CPUID_VERSION);
312 hv_host_info_ecx = cpuid_ecx(HYPERV_CPUID_VERSION);
313 hv_host_info_edx = cpuid_edx(HYPERV_CPUID_VERSION);
315 pr_info("Hyper-V Host Build:%d-%d.%d-%d-%d.%d\n",
316 hv_host_info_eax, hv_host_info_ebx >> 16,
317 hv_host_info_ebx & 0xFFFF, hv_host_info_ecx,
318 hv_host_info_edx >> 24, hv_host_info_edx & 0xFFFFFF);
321 if (ms_hyperv.features & HV_ACCESS_FREQUENCY_MSRS &&
322 ms_hyperv.misc_features & HV_FEATURE_FREQUENCY_MSRS_AVAILABLE) {
323 x86_platform.calibrate_tsc = hv_get_tsc_khz;
324 x86_platform.calibrate_cpu = hv_get_tsc_khz;
327 if (ms_hyperv.priv_high & HV_ISOLATION) {
328 ms_hyperv.isolation_config_a = cpuid_eax(HYPERV_CPUID_ISOLATION_CONFIG);
329 ms_hyperv.isolation_config_b = cpuid_ebx(HYPERV_CPUID_ISOLATION_CONFIG);
331 pr_info("Hyper-V: Isolation Config: Group A 0x%x, Group B 0x%x\n",
332 ms_hyperv.isolation_config_a, ms_hyperv.isolation_config_b);
335 if (hv_max_functions_eax >= HYPERV_CPUID_NESTED_FEATURES) {
336 ms_hyperv.nested_features =
337 cpuid_eax(HYPERV_CPUID_NESTED_FEATURES);
338 pr_info("Hyper-V: Nested features: 0x%x\n",
339 ms_hyperv.nested_features);
342 #ifdef CONFIG_X86_LOCAL_APIC
343 if (ms_hyperv.features & HV_ACCESS_FREQUENCY_MSRS &&
344 ms_hyperv.misc_features & HV_FEATURE_FREQUENCY_MSRS_AVAILABLE) {
346 * Get the APIC frequency.
348 u64 hv_lapic_frequency;
350 rdmsrl(HV_X64_MSR_APIC_FREQUENCY, hv_lapic_frequency);
351 hv_lapic_frequency = div_u64(hv_lapic_frequency, HZ);
352 lapic_timer_period = hv_lapic_frequency;
353 pr_info("Hyper-V: LAPIC Timer Frequency: %#x\n",
357 register_nmi_handler(NMI_UNKNOWN, hv_nmi_unknown, NMI_FLAG_FIRST,
361 #ifdef CONFIG_X86_IO_APIC
365 #if IS_ENABLED(CONFIG_HYPERV) && defined(CONFIG_KEXEC_CORE)
366 machine_ops.shutdown = hv_machine_shutdown;
367 machine_ops.crash_shutdown = hv_machine_crash_shutdown;
369 if (ms_hyperv.features & HV_ACCESS_TSC_INVARIANT) {
371 * Writing to synthetic MSR 0x40000118 updates/changes the
372 * guest visible CPUIDs. Setting bit 0 of this MSR enables
373 * guests to report invariant TSC feature through CPUID
374 * instruction, CPUID 0x800000007/EDX, bit 8. See code in
375 * early_init_intel() where this bit is examined. The
376 * setting of this MSR bit should happen before init_intel()
379 wrmsrl(HV_X64_MSR_TSC_INVARIANT_CONTROL, 0x1);
380 setup_force_cpu_cap(X86_FEATURE_TSC_RELIABLE);
384 * Generation 2 instances don't support reading the NMI status from
387 if (efi_enabled(EFI_BOOT))
388 x86_platform.get_nmi_reason = hv_get_nmi_reason;
391 * Hyper-V VMs have a PIT emulation quirk such that zeroing the
392 * counter register during PIT shutdown restarts the PIT. So it
393 * continues to interrupt @18.2 HZ. Setting i8253_clear_counter
394 * to false tells pit_shutdown() not to zero the counter so that
395 * the PIT really is shutdown. Generation 2 VMs don't have a PIT,
396 * and setting this value has no effect.
398 i8253_clear_counter_on_shutdown = false;
400 #if IS_ENABLED(CONFIG_HYPERV)
402 * Setup the hook to get control post apic initialization.
404 x86_platform.apic_post_init = hyperv_init;
405 hyperv_setup_mmu_ops();
406 /* Setup the IDT for hypervisor callback */
407 alloc_intr_gate(HYPERVISOR_CALLBACK_VECTOR, asm_sysvec_hyperv_callback);
409 /* Setup the IDT for reenlightenment notifications */
410 if (ms_hyperv.features & HV_ACCESS_REENLIGHTENMENT) {
411 alloc_intr_gate(HYPERV_REENLIGHTENMENT_VECTOR,
412 asm_sysvec_hyperv_reenlightenment);
415 /* Setup the IDT for stimer0 */
416 if (ms_hyperv.misc_features & HV_STIMER_DIRECT_MODE_AVAILABLE) {
417 alloc_intr_gate(HYPERV_STIMER0_VECTOR,
418 asm_sysvec_hyperv_stimer0);
422 smp_ops.smp_prepare_boot_cpu = hv_smp_prepare_boot_cpu;
423 if (hv_root_partition)
424 smp_ops.smp_prepare_cpus = hv_smp_prepare_cpus;
428 * Hyper-V doesn't provide irq remapping for IO-APIC. To enable x2apic,
429 * set x2apic destination mode to physical mode when x2apic is available
430 * and Hyper-V IOMMU driver makes sure cpus assigned with IO-APIC irqs
431 * have 8-bit APIC id.
433 # ifdef CONFIG_X86_X2APIC
434 if (x2apic_supported())
438 /* Register Hyper-V specific clocksource */
439 hv_init_clocksource();
442 * TSC should be marked as unstable only after Hyper-V
443 * clocksource has been initialized. This ensures that the
444 * stability of the sched_clock is not altered.
446 if (!(ms_hyperv.features & HV_ACCESS_TSC_INVARIANT))
447 mark_tsc_unstable("running on Hyper-V");
450 static bool __init ms_hyperv_x2apic_available(void)
452 return x2apic_supported();
456 * If ms_hyperv_msi_ext_dest_id() returns true, hyperv_prepare_irq_remapping()
457 * returns -ENODEV and the Hyper-V IOMMU driver is not used; instead, the
458 * generic support of the 15-bit APIC ID is used: see __irq_msi_compose_msg().
460 * Note: for a VM on Hyper-V, the I/O-APIC is the only device which
461 * (logically) generates MSIs directly to the system APIC irq domain.
462 * There is no HPET, and PCI MSI/MSI-X interrupts are remapped by the
463 * pci-hyperv host bridge.
465 static bool __init ms_hyperv_msi_ext_dest_id(void)
469 eax = cpuid_eax(HYPERV_CPUID_VIRT_STACK_INTERFACE);
470 if (eax != HYPERV_VS_INTERFACE_EAX_SIGNATURE)
473 eax = cpuid_eax(HYPERV_CPUID_VIRT_STACK_PROPERTIES);
474 return eax & HYPERV_VS_PROPERTIES_EAX_EXTENDED_IOAPIC_RTE;
477 const __initconst struct hypervisor_x86 x86_hyper_ms_hyperv = {
478 .name = "Microsoft Hyper-V",
479 .detect = ms_hyperv_platform,
480 .type = X86_HYPER_MS_HYPERV,
481 .init.x2apic_available = ms_hyperv_x2apic_available,
482 .init.msi_ext_dest_id = ms_hyperv_msi_ext_dest_id,
483 .init.init_platform = ms_hyperv_init_platform,